summaryrefslogtreecommitdiff
path: root/string.c
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2025-11-18 20:56:14 -0600
committerGitHub <noreply@github.com>2025-11-18 21:56:14 -0500
commit319001192d59bc57923ba3838eb83685cb3af014 (patch)
tree63972f562b1f257ee05c8c04b461ed6dba64720b /string.c
parent3ee08c8df8581ca5b1a95dae0f5825abf54700f4 (diff)
[DOC] Tweaks for String#dump and String#undump
Diffstat (limited to 'string.c')
-rw-r--r--string.c12
1 files changed, 3 insertions, 9 deletions
diff --git a/string.c b/string.c
index 827555d9e0..f371e185d6 100644
--- a/string.c
+++ b/string.c
@@ -7628,17 +7628,11 @@ static VALUE rb_str_is_ascii_only_p(VALUE str);
/*
* call-seq:
- * undump -> string
+ * undump -> new_string
*
- * Returns an unescaped version of +self+:
- *
- * s_orig = "\f\x00\xff\\\"" # => "\f\u0000\xFF\\\""
- * s_dumped = s_orig.dump # => "\"\\f\\x00\\xFF\\\\\\\"\""
- * s_undumped = s_dumped.undump # => "\f\u0000\xFF\\\""
- * s_undumped == s_orig # => true
- *
- * Related: String#dump (inverse of String#undump).
+ * Inverse of String#dump; returns a copy of +self+ with changes of the kinds made by String#dump "undone."
*
+ * Related: see {Converting to New String}[rdoc-ref:String@Converting+to+New+String].
*/
static VALUE