summaryrefslogtreecommitdiff
path: root/string.c
diff options
context:
space:
mode:
authorBurdetteLamar <burdettelamar@yahoo.com>2025-09-08 14:10:24 +0100
committerPeter Zhu <peter@peterzhu.ca>2025-09-09 19:33:10 +0200
commit9e3a16220c33201229ad6ec99bf179c7c41d2f58 (patch)
tree4839ee6b7bd3d8f4a3acf839506d840263f87a02 /string.c
parentd524e795af85d8763f2e0e1203b3a4af131ce984 (diff)
[DOC] Tweaks for String#lstrip!
Diffstat (limited to 'string.c')
-rw-r--r--string.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/string.c b/string.c
index 01cfc9c175..20873a35a5 100644
--- a/string.c
+++ b/string.c
@@ -10361,10 +10361,12 @@ lstrip_offset(VALUE str, const char *s, const char *e, rb_encoding *enc)
* call-seq:
* lstrip! -> self or nil
*
- * Like String#lstrip, except that any modifications are made in +self+;
- * returns +self+ if any modification are made, +nil+ otherwise.
+ * Like String#lstrip, except that:
+ *
+ * - Performs stripping in +self+ (not in a copy of +self+).
+ * - Returns +self+ if any characters are stripped, +nil+ otherwise.
*
- * Related: String#rstrip!, String#strip!.
+ * Related: see {Modifying}[rdoc-ref:String@Modifying].
*/
static VALUE