summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--string.c21
1 files changed, 12 insertions, 9 deletions
diff --git a/string.c b/string.c
index 2691d85c66..0148d55be2 100644
--- a/string.c
+++ b/string.c
@@ -5228,19 +5228,22 @@ rb_str_tr_bang(VALUE str, VALUE src, VALUE repl)
/*
* call-seq:
- * str.tr(from_str, to_str) -> new_str
+ * str.tr(from_str, to_str) => new_str
*
- * Returns a copy of <i>str</i> with the characters in <i>from_str</i> replaced
- * by the corresponding characters in <i>to_str</i>. If <i>to_str</i> is
- * shorter than <i>from_str</i>, it is padded with its last character. Both
- * strings may use the c1--c2 notation to denote ranges of characters, and
- * <i>from_str</i> may start with a <code>^</code>, which denotes all
- * characters except those listed.
+ * Returns a copy of <i>str</i> with the characters in <i>from_str</i>
+ * replaced by the corresponding characters in <i>to_str</i>. If
+ * <i>to_str</i> is shorter than <i>from_str</i>, it is padded with its last
+ * character in order to maintain the correspondence.
*
- * "hello".tr('aeiou', '*') #=> "h*ll*"
- * "hello".tr('^aeiou', '*') #=> "*e**o"
* "hello".tr('el', 'ip') #=> "hippo"
+ * "hello".tr('aeiou', '*') #=> "h*ll*"
+ *
+ * Both strings may use the c1-c2 notation to denote ranges of characters,
+ * and <i>from_str</i> may start with a <code>^</code>, which denotes all
+ * characters except those listed.
+ *
* "hello".tr('a-y', 'b-z') #=> "ifmmp"
+ * "hello".tr('^aeiou', '*') #=> "*e**o"
*/
static VALUE