diff options
author | Burdette Lamar <[email protected]> | 2022-04-03 10:09:34 -0500 |
---|---|---|
committer | GitHub <[email protected]> | 2022-04-03 10:09:34 -0500 |
commit | 0b0ae583f4e25e378294df5e19a76f9fd541a6d0 (patch) | |
tree | 657f8d8c4c9cb56a6276138e3216f324f27ceed7 | |
parent | f801386f0c7051085da9d6ca660642f3aa08c81e (diff) |
[DOC] Enhanced RDoc for String (#5753)
Treats:
#length
#bytesize
Notes
Notes:
Merged-By: BurdetteLamar <[email protected]>
-rw-r--r-- | doc/string/bytesize.rdoc | 11 | ||||
-rw-r--r-- | doc/string/length.rdoc | 13 | ||||
-rw-r--r-- | string.c | 14 |
3 files changed, 26 insertions, 12 deletions
diff --git a/doc/string/bytesize.rdoc b/doc/string/bytesize.rdoc new file mode 100644 index 0000000000..b0567ff67b --- /dev/null +++ b/doc/string/bytesize.rdoc @@ -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 diff --git a/doc/string/length.rdoc b/doc/string/length.rdoc new file mode 100644 index 0000000000..0a7e17f7dc --- /dev/null +++ b/doc/string/length.rdoc @@ -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. @@ -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+: - * - * "\x80\u3042".bytesize # => 4 - * "hello".bytesize # => 5 + * :include: doc/string/bytesize.rdoc * - * Related: String#length. */ static VALUE |