Document the :as option for the scope method

rails · Nov 15, 2010 · 06402b0 · 06402b0
1 parent 0db8412
commit 06402b0
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/actionpack/lib/action_dispatch/routing/mapper.rb b/actionpack/lib/action_dispatch/routing/mapper.rb
@@ -445,7 +445,17 @@ def initialize(*args) #:nodoc:
         #     scope :path => "/admin" do
         #       resources :posts
         #     end
+        #
         # This will prefix all of the +posts+ resource's requests with '/admin'
+        #
+        # [:as]
+        #  Prefixes the routing helpers in this scope with the specified label.
+        #
+        #  scope :as => "sekret" do
+        #    resources :posts
+        #  end
+        #
+        # Helpers such as +posts_path+ will now be +sekret_posts_path+
         def scope(*args)
           options = args.extract_options!
           options = options.dup