summaryrefslogtreecommitdiff
path: root/string.c
diff options
context:
space:
mode:
authorBurdetteLamar <burdettelamar@yahoo.com>2025-10-21 19:16:00 +0100
committerPeter Zhu <peter@peterzhu.ca>2025-10-21 16:48:29 -0400
commit193b299b8d1b09de9de695f6fd88314ccfbf884b (patch)
treec7e5b9c4a92b1c4077ca87d4c93c2f976c1f4486 /string.c
parentcb52809ca124cb627293a666e8cbb44e031eeec1 (diff)
[DOC] ”Tweaks for String#setbyte
Diffstat (limited to 'string.c')
-rw-r--r--string.c11
1 files changed, 6 insertions, 5 deletions
diff --git a/string.c b/string.c
index 8f9d19fb54..9254162263 100644
--- a/string.c
+++ b/string.c
@@ -6667,13 +6667,14 @@ rb_str_getbyte(VALUE str, VALUE index)
* call-seq:
* setbyte(index, integer) -> integer
*
- * Sets the byte at zero-based +index+ to +integer+; returns +integer+:
+ * Sets the byte at zero-based offset +index+ to the value of the given +integer+;
+ * returns +integer+:
*
- * s = 'abcde' # => "abcde"
- * s.setbyte(0, 98) # => 98
- * s # => "bbcde"
+ * s = 'xyzzy'
+ * s.setbyte(2, 129) # => 129
+ * s # => "xy\x81zy"
*
- * Related: String#getbyte.
+ * Related: see {Modifying}[rdoc-ref:String@Modifying].
*/
VALUE
rb_str_setbyte(VALUE str, VALUE index, VALUE value)