1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Fix String#getbyte doc

Browse Source 
* String#getbyte returns `nil` if `index` is out of range.

* Add String#getbyte example with nil output.

* Modify String#getbyte example to use negative index.
This commit is contained in:
Mau Magnaguagno 2022-02-28 22:05:49 -03:00 committed by GitHub
parent 1a20bb1c98
commit 347c3faf8e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
Notes: git 2022-03-01 10:06:10 +09:00 
Merged: https://github.com/ruby/ruby/pull/5586

Merged-By: nobu <nobu@ruby-lang.org>
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
string.c
View File

@ -6070,13 +6070,14 @@ rb_str_chr(VALUE str)
/*
* call-seq:
* getbyte(index) -> integer
* getbyte(index) -> integer or nil
*
* Returns the byte at zero-based +index+ as an integer:
* Returns the byte at zero-based +index+ as an integer, or +nil+ if +index+ is out of range:
*
* s = 'abcde' # => "abcde"
* s.getbyte(0) # => 97
* s.getbyte(1) # => 98
* s = 'abcde' # => "abcde"
* s.getbyte(0) # => 97
* s.getbyte(-1) # => 101
* s.getbyte(5) # => nil
*
* Related: String#setbyte.
*/