summaryrefslogtreecommitdiff
path: root/doc/string/center.rdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/string/center.rdoc')
-rw-r--r--doc/string/center.rdoc16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/string/center.rdoc b/doc/string/center.rdoc
new file mode 100644
index 0000000000..d53d921ad5
--- /dev/null
+++ b/doc/string/center.rdoc
@@ -0,0 +1,16 @@
+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 both ends with +pad_string+:
+
+ 'hello'.center(10) # => " hello "
+ ' hello'.center(10) # => " hello "
+ 'hello'.center(10, 'ab') # => "abhelloaba"
+ 'тест'.center(10) # => " тест "
+ 'こんにちは'.center(10) # => " こんにちは "
+
+If +size+ is not greater than the size of +self+, returns a copy of +self+:
+
+ 'hello'.center(5) # => "hello"
+ 'hello'.center(1) # => "hello"