Enhanced RDoc for String#succ (#3590)

* Enhanced RDoc for String#succ
This commit is contained in:
Burdette Lamar 2020-09-25 15:13:10 -05:00 committed by GitHub
parent 24820d508b
commit 8b42474a26
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
Notes: git 2020-09-26 05:13:37 +09:00
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>

View File

@ -4160,27 +4160,55 @@ static VALUE str_succ(VALUE str);
/* /*
* call-seq: * call-seq:
* str.succ -> new_str * string.succ -> new_str
* str.next -> new_str
* *
* Returns the successor to <i>str</i>. The successor is calculated by * Returns the successor to +self+. The successor is calculated by
* incrementing characters starting from the rightmost alphanumeric (or * incrementing characters.
* the rightmost character if there are no alphanumerics) in the
* string. Incrementing a digit always results in another digit, and
* incrementing a letter results in another letter of the same case.
* Incrementing nonalphanumerics uses the underlying character set's
* collating sequence.
* *
* If the increment generates a ``carry,'' the character to the left of * The first character to be incremented is the rightmost alphanumeric:
* it is incremented. This process repeats until there is no carry, * or, if no alphanumerics, the rightmost character:
* adding an additional character if necessary. * 'THX1138'.succ # => "THX1139"
* '<<koala>>'.succ # => "<<koalb>>"
* '***'.succ # => '**+'
* *
* "abcd".succ #=> "abce" * The successor to a digit is another digit, "carrying" to the next-left
* "THX1138".succ #=> "THX1139" * character for a "rollover" from 9 to 0, and prepending another digit
* "<<koala>>".succ #=> "<<koalb>>" * if necessary:
* "1999zzz".succ #=> "2000aaa" * '00'.succ # => "01"
* "ZZZ9999".succ #=> "AAAA0000" * '09'.succ # => "10"
* "***".succ #=> "**+" * '99'.succ # => "100"
*
* The successor to a letter is another letter of the same case,
* carrying to the next-left character for a rollover,
* and prepending another same-case letter if necessary:
* 'aa'.succ # => "ab"
* 'az'.succ # => "ba"
* 'zz'.succ # => "aaa"
* 'AA'.succ # => "AB"
* 'AZ'.succ # => "BA"
* 'ZZ'.succ # => "AAA"
*
* The successor to a non-alphanumeric character is the next character
* in the underlying character set's collating sequence,
* carrying to the next-left character for a rollover,
* and prepending another character if necessary:
* s = 0.chr * 3
* s # => "\x00\x00\x00"
* s.succ # => "\x00\x00\x01"
* s = 255.chr * 3
* s # => "\xFF\xFF\xFF"
* s.succ # => "\x01\x00\x00\x00"
*
* Carrying can occur between and among mixtures of alphanumeric characters:
* s = 'zz99zz99'
* s.succ # => "aaa00aa00"
* s = '99zz99zz'
* s.succ # => "100aa00aa"
*
* The successor to an empty \String is a new empty \String:
* ''.succ # => ""
*
* String#next is an alias for String#succ.
*/ */
VALUE VALUE