summaryrefslogtreecommitdiff
path: root/parse.y
diff options
context:
space:
mode:
authorstomar <stomar@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-04-08 19:39:38 +0000
committerstomar <stomar@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-04-08 19:39:38 +0000
commitd33ddd631bc2e4484bc6c7df980ecaf8e29e8b8f (patch)
tree6357463a2bc2dc77677375c39332ef7852447c3f /parse.y
parent610dc339b67d3d296eb3a9fd41a12c6e6ad1149f (diff)
parse.y: fix docs for Ripper.dedent_string
* parse.y: [DOC] fix return type in call-seq of Ripper.dedent_string, clarify the method's behavior. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@63121 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'parse.y')
-rw-r--r--parse.y6
1 files changed, 3 insertions, 3 deletions
diff --git a/parse.y b/parse.y
index a4b811511e..e4e82516d2 100644
--- a/parse.y
+++ b/parse.y
@@ -6130,10 +6130,10 @@ heredoc_dedent(struct parser_params *p, VALUE array)
/*
* call-seq:
- * Ripper.dedent_string(input, width) -> string
+ * Ripper.dedent_string(input, width) -> Integer
*
- * Strips leading +width+ whitespaces from +input+, and returns
- * stripped column width.
+ * Strips up to +width+ leading whitespaces from +input+,
+ * and returns the stripped column width.
*/
static VALUE
parser_dedent_string(VALUE self, VALUE input, VALUE width)