diff options
author | Burdette Lamar <BurdetteLamar@Yahoo.com> | 2022-04-04 14:18:10 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-04-04 14:18:10 -0500 |
commit | 4a4485adbd13a75019ece34490b291da1dde8d91 (patch) | |
tree | e29ca4d8d404ca3596c7445459694f115d591421 /string.c | |
parent | 48520cc1b61e6ebdc9d2ad6d936fe01aaf0cd5b9 (diff) |
Enhanced RDoc for String#index (#5759)
Notes
Notes:
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
Diffstat (limited to 'string.c')
-rw-r--r-- | string.c | 31 |
1 files changed, 1 insertions, 30 deletions
@@ -3850,37 +3850,8 @@ rb_strseq_index(VALUE str, VALUE sub, long offset, int in_byte) * index(substring, offset = 0) -> integer or nil * index(regexp, offset = 0) -> integer or nil * - * Returns the \Integer index of the first occurrence of the given +substring+, - * or +nil+ if none found: - * - * 'foo'.index('f') # => 0 - * 'foo'.index('o') # => 1 - * 'foo'.index('oo') # => 1 - * 'foo'.index('ooo') # => nil - * - * Returns the \Integer index of the first match for the given \Regexp +regexp+, - * or +nil+ if none found: - * - * 'foo'.index(/f/) # => 0 - * 'foo'.index(/o/) # => 1 - * 'foo'.index(/oo/) # => 1 - * 'foo'.index(/ooo/) # => nil - * - * \Integer argument +offset+, if given, specifies the position in the - * string to begin the search: - * - * 'foo'.index('o', 1) # => 1 - * 'foo'.index('o', 2) # => 2 - * 'foo'.index('o', 3) # => nil - * - * If +offset+ is negative, counts backward from the end of +self+: - * - * 'foo'.index('o', -1) # => 2 - * 'foo'.index('o', -2) # => 1 - * 'foo'.index('o', -3) # => 1 - * 'foo'.index('o', -4) # => nil + * :include: doc/string/index.rdoc * - * Related: String#rindex. */ static VALUE |