summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--string.c5
1 files changed, 4 insertions, 1 deletions
diff --git a/string.c b/string.c
index ccf4796d3b..3741d449f4 100644
--- a/string.c
+++ b/string.c
@@ -6002,7 +6002,10 @@ rb_str_inspect(VALUE str)
* str.dump -> new_str
*
* Produces a version of +str+ with all non-printing characters replaced by
- * <code>\nnn</code> notation and all special characters escaped.
+ * <code>\xnn</code> notation and all special characters escaped.
+ *
+ * This API is intended for round-trip: if the result string is eval'ed,
+ * it produces the original string.
*
* "hello \n ''".dump #=> "\"hello \\n ''\""
*/