summaryrefslogtreecommitdiff
path: root/doc/string/rjust.rdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/string/rjust.rdoc')
-rw-r--r--doc/string/rjust.rdoc17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/string/rjust.rdoc b/doc/string/rjust.rdoc
new file mode 100644
index 0000000000..acd3f198d4
--- /dev/null
+++ b/doc/string/rjust.rdoc
@@ -0,0 +1,17 @@
+Returns a right-justified copy of +self+.
+
+If integer argument +width+ is greater than the size (in characters) of +self+,
+returns a new string of length +width+ that is a copy of +self+,
+right justified and padded on the left with +pad_string+:
+
+ 'hello'.rjust(10) # => " hello"
+ 'hello '.rjust(10) # => " hello "
+ 'hello'.rjust(10, 'ab') # => "ababahello"
+ 'こんにちは'.rjust(10) # => " こんにちは"
+
+If <tt>width <= self.size</tt>, returns a copy of +self+:
+
+ 'hello'.rjust(5, 'ab') # => "hello"
+ 'hello'.rjust(1, 'ab') # => "hello"
+
+Related: see {Converting to New String}[rdoc-ref:String@Converting+to+New+String].