Improvements to documentation.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66897 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 4 insertions, 4 deletions

diff --git a/string.c b/string.c
index 3741d449f4..743fe79423 100644
--- a/string.c
+++ b/string.c
@@ -6001,11 +6001,11 @@ rb_str_inspect(VALUE str)
  *  call-seq:
  *     str.dump   -> new_str
  *
- *  Produces a version of +str+ with all non-printing characters replaced by
- *  <code>\xnn</code> notation and all special characters escaped.
+ *  Produces a quoted version of +str+ with all non-printing characters replaced
+ *  by <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.
+ *  This method can be used for round-trip: if the resulting +new_str+ is
+ *  eval'ed, it will produce the original string.
  *
  *    "hello \n ''".dump  #=> "\"hello \\n ''\""
  */