summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2025-10-21 15:46:40 -0500
committerGitHub <noreply@github.com>2025-10-21 16:46:40 -0400
commit862b42a52cd59ca406db40cf47e98fa107c97fd1 (patch)
tree1e38bbed8f28057e8dc00387e693d7a7d2b4e67b
parent42c040978157d7964b2d162f9b20805e010e3a99 (diff)
[DOC] Tweaks for String#scrub! (#14893)
-rw-r--r--string.c12
1 files changed, 8 insertions, 4 deletions
diff --git a/string.c b/string.c
index 8788c0ca67..344b38d255 100644
--- a/string.c
+++ b/string.c
@@ -11927,11 +11927,15 @@ str_scrub(int argc, VALUE *argv, VALUE str)
/*
* call-seq:
- * scrub! -> self
- * scrub!(replacement_string = default_replacement) -> self
- * scrub!{|bytes| ... } -> self
+ * scrub!(replacement_string = default_replacement_string) -> self
+ * scrub!{|sequence| ... } -> self
*
- * Like String#scrub, except that any replacements are made in +self+.
+ * Like String#scrub, except that:
+ *
+ * - Any replacements are made in +self+.
+ * - Returns +self+.
+ *
+ * Related: see {Modifying}[rdoc-ref:String@Modifying].
*
*/
static VALUE