[DOC] Enhanced RDoc for String (#5753)

Treats:
    #length
    #bytesize
This commit is contained in:
Burdette Lamar 2022-04-03 10:09:34 -05:00 committed by GitHub
parent f801386f0c
commit 0b0ae583f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
Notes: git 2022-04-04 00:10:05 +09:00
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
3 changed files with 26 additions and 12 deletions

11
doc/string/bytesize.rdoc Normal file
View File

@ -0,0 +1,11 @@
Returns the count of bytes (not characters) in +self+:
'foo'.bytesize # => 3
'тест'.bytesize # => 8
'こんにちは'.bytesize # => 15
Contrast with String#length:
'foo'.length # => 3
'тест'.length # => 4
'こんにちは'.length # => 5

13
doc/string/length.rdoc Normal file
View File

@ -0,0 +1,13 @@
Returns the count of characters (not bytes) in +self+:
'foo'.length # => 3
'тест'.length # => 4
'こんにちは'.length # => 5
Contrast with String#bytesize:
'foo'.bytesize # => 3
'тест'.bytesize # => 8
'こんにちは'.bytesize # => 15
String#size is an alias for String#length.

View File

@ -2115,14 +2115,8 @@ rb_str_strlen(VALUE str)
* call-seq:
* length -> integer
*
* Returns the count of characters (not bytes) in +self+:
* :include: doc/string/length.rdoc
*
* "\x80\u3042".length # => 2
* "hello".length # => 5
*
* String#size is an alias for String#length.
*
* Related: String#bytesize.
*/
VALUE
@ -2135,12 +2129,8 @@ rb_str_length(VALUE str)
* call-seq:
* bytesize -> integer
*
* Returns the count of bytes in +self+:
* :include: doc/string/bytesize.rdoc
*
* "\x80\u3042".bytesize # => 4
* "hello".bytesize # => 5
*
* Related: String#length.
*/
static VALUE