summaryrefslogtreecommitdiff
path: root/string.c
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2020-09-28 11:58:39 -0500
committerGitHub <noreply@github.com>2020-09-28 11:58:39 -0500
commit0555bd8435d352a24bab1e03a7879b9abcc34b88 (patch)
treedd92874ccdeff4594a2828d840aa7e7bd013f6b8 /string.c
parentd598654c742eddc4284814021a8d4b1d6e48b604 (diff)
Enhanced RDoc for String#succ! (#3596)
* Enhanced RDoc for String#succ!
Notes
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
Diffstat (limited to 'string.c')
-rw-r--r--string.c7
1 files changed, 4 insertions, 3 deletions
diff --git a/string.c b/string.c
index cf25dc1861..4ffd57cd5e 100644
--- a/string.c
+++ b/string.c
@@ -4310,10 +4310,11 @@ str_succ(VALUE str)
/*
* call-seq:
- * str.succ! -> str
- * str.next! -> str
+ * string.succ! -> self
*
- * Equivalent to String#succ, but modifies the receiver in place.
+ * Equivalent to String#succ, but modifies +self+ in place; returns +self+.
+ *
+ * String#next! is an alias for String#succ!.
*/
static VALUE