aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib/active_support/core_ext/string/access.rb
diff options
context:
space:
mode:
authorFrancesco Rodriguez <lrodriguezsanc@gmail.com>2012-05-11 11:47:40 -0500
committerFrancesco Rodriguez <lrodriguezsanc@gmail.com>2012-05-11 11:47:40 -0500
commit07045fa919b4787d8ec458a1594f62cdedaf1b06 (patch)
tree64486b61968b83795c5c90fbcff21e7ceffa8c47 /activesupport/lib/active_support/core_ext/string/access.rb
parent0822dc01f68eb262274fbedcf97a224e6457ff3b (diff)
downloadrails-07045fa919b4787d8ec458a1594f62cdedaf1b06.tar.gz
rails-07045fa919b4787d8ec458a1594f62cdedaf1b06.tar.bz2
rails-07045fa919b4787d8ec458a1594f62cdedaf1b06.zip
added docs to String#from
Diffstat (limited to 'activesupport/lib/active_support/core_ext/string/access.rb')
-rw-r--r--activesupport/lib/active_support/core_ext/string/access.rb13
1 files changed, 13 insertions, 0 deletions
diff --git a/activesupport/lib/active_support/core_ext/string/access.rb b/activesupport/lib/active_support/core_ext/string/access.rb
index 9494a9b69d..1436d43be6 100644
--- a/activesupport/lib/active_support/core_ext/string/access.rb
+++ b/activesupport/lib/active_support/core_ext/string/access.rb
@@ -30,6 +30,19 @@ class String
self[position]
end
+ # Returns a substring from the given position to the end of the string.
+ # If the position is negative, it is counted from the end of the string.
+ #
+ # str = "hello"
+ # str.from(0) #=> "hello"
+ # str.from(3) #=> "lo"
+ # str.from(-2) #=> "lo"
+ #
+ # You can mix it with +to+ method and do fun things like:
+ #
+ # str = "hello"
+ # str.from(0).to(-1) #=> "hello"
+ # str.from(1).to(-2) #=> "ell"
def from(position)
self[position..-1]
end