From 2061c98b42b1d44bc9ca4352c2f5a4ee1a956a4a Mon Sep 17 00:00:00 2001
From: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Date: Sun, 20 Jan 2013 22:47:41 -0200
Subject: Review #translate docs [ci skip]

---
 actionpack/lib/abstract_controller/translation.rb | 15 +++++++--------
 1 file changed, 7 insertions(+), 8 deletions(-)

(limited to 'actionpack/lib/abstract_controller')

diff --git a/actionpack/lib/abstract_controller/translation.rb b/actionpack/lib/abstract_controller/translation.rb
index 85a6b6ade1..db48022b9f 100644
--- a/actionpack/lib/abstract_controller/translation.rb
+++ b/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 @@ module AbstractController
     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
-- 
cgit v1.2.3