Permalink
Browse files

Add documentation for abstract controller #translate and #localize me…

…thod.
  • Loading branch information...
bsingr committed Jan 20, 2013
1 parent 56498b4 commit 37d15d4e1b22b4566b0c409c00680b4d961a194c
Showing with 10 additions and 0 deletions.
  1. +10 −0 actionpack/lib/abstract_controller/translation.rb
@@ -1,5 +1,14 @@
module AbstractController
module Translation
+ # Delegates to <tt>I18n#translate</tt> but also performs one additional function.
+ #
+ # 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
+ # <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.
def translate(*args)
key = args.first
if key.is_a?(String) && (key[0] == '.')
@@ -11,6 +20,7 @@ def translate(*args)
end
alias :t :translate
+ # Delegates to <tt>I18n.localize</tt> with no additional functionality.
def localize(*args)
I18n.localize(*args)
end

0 comments on commit 37d15d4

Please sign in to comment.