diff options
Diffstat (limited to 'doc/string/center.rdoc')
| -rw-r--r-- | doc/string/center.rdoc | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/string/center.rdoc b/doc/string/center.rdoc new file mode 100644 index 0000000000..b86c8b5916 --- /dev/null +++ b/doc/string/center.rdoc @@ -0,0 +1,19 @@ +Returns a centered copy of +self+. + +If integer argument +size+ is greater than the size (in characters) of +self+, +returns a new string of length +size+ that is a copy of +self+, +centered and padded on one or both ends with +pad_string+: + + 'hello'.center(6) # => "hello " # Padded on one end. + 'hello'.center(10) # => " hello " # Padded on both ends. + 'hello'.center(20, '-|') # => "-|-|-|-hello-|-|-|-|" # Some padding repeated. + 'hello'.center(10, 'abcdefg') # => "abhelloabc" # Some padding not used. + ' hello '.center(13) # => " hello " + 'こんにちは'.center(10) # => " こんにちは " # Multi-byte characters. + +If +size+ is less than or equal to the size of +self+, returns an unpadded copy of +self+: + + 'hello'.center(5) # => "hello" + 'hello'.center(-10) # => "hello" + +Related: see {Converting to New String}[rdoc-ref:String@Converting+to+New+String]. |
