Permalink
Browse files

Review #translate docs [ci skip]

  • Loading branch information...
1 parent 37d15d4 commit 2061c98b42b1d44bc9ca4352c2f5a4ee1a956a4a @carlosantoniodasilva carlosantoniodasilva committed Jan 21, 2013
Showing with 7 additions and 8 deletions.
  1. +7 −8 actionpack/lib/abstract_controller/translation.rb
@@ -1,14 +1,13 @@
module AbstractController
module Translation
- # Delegates to <tt>I18n#translate</tt> but also performs one additional function.
+ # Delegates to <tt>I18n.translate</tt>. Also aliased as <tt>t</tt>.
#
- # It'll scope the key by the current action if the key starts
- # with a period. So if you call <tt>translate(".foo")</tt> from the
- # <tt>PeopleController#index</tt> action, you'll actually be calling
+ # When the given key starts with a period, it will be scoped by the current
+ # controller and action. So if you call <tt>translate(".foo")</tt> from
+ # <tt>PeopleController#index</tt>, it will convert the call to
# <tt>I18n.translate("people.index.foo")</tt>. This makes it less repetitive
- # to translate many keys within the same controller / action and gives you a simple framework
- # for scoping them consistently. If you don't prepend the key with a period,
- # nothing is converted.
+ # to translate many keys within the same controller / action and gives you a
+ # simple framework for scoping them consistently.
def translate(*args)
key = args.first
if key.is_a?(String) && (key[0] == '.')
@@ -20,7 +19,7 @@ def translate(*args)
end
alias :t :translate
- # Delegates to <tt>I18n.localize</tt> with no additional functionality.
+ # Delegates to <tt>I18n.localize</tt>. Also aliased as <tt>l</tt>.
def localize(*args)
I18n.localize(*args)
end

0 comments on commit 2061c98

Please sign in to comment.