Skip to content
Browse files

added docs to String#at

  • Loading branch information...
1 parent 1b95670 commit 7ce4ce33c7c3229752c51dd92ca9d758ec452fc1 Francesco Rodriguez committed
Showing with 25 additions and 0 deletions.
  1. +25 −0 activesupport/lib/active_support/core_ext/string/access.rb
View
25 activesupport/lib/active_support/core_ext/string/access.rb
@@ -1,6 +1,31 @@
require 'active_support/multibyte'
class String
+ # If you pass a single Fixnum, returns a substring of one character at that
+ # position. The first character of the string is at position 0, the next at
+ # position 1, and so on. If a range is supplied, a substring containing
+ # characters at offsets given by the range is returned. In both cases, if an
+ # offset is negative, it is counted from the end of the string. Returns nil
+ # if the initial offset falls outside the string. Returns an empty string if
+ # the beginning of the range is greater than the end of the string.
+ #
+ # str = "hello"
+ # str.at(0) #=> "h"
+ # str.at(1..3) #=> "ell"
+ # str.at(-2) #=> "l"
+ # str.at(-2..-1) #=> "lo"
+ # str.at(5) #=> nil
+ # str.at(5..-1) #=> ""
+ #
+ # If a Regexp is given, the matching portion of the string is returned.
+ # If a String is given, that given string is returned if it occurs in
+ # the string. In both cases, nil is returned if there is no match.
+ #
+ # str = "hello"
+ # str.at(/lo/) #=> "lo"
+ # str.at(/ol/) #=> nil
+ # str.at("lo") #=> "lo"
+ # str.at("ol") #=> nil
def at(position)
self[position]
end

0 comments on commit 7ce4ce3

Please sign in to comment.
Something went wrong with that request. Please try again.