root method options are the same as the match method

rails · Dec 11, 2010 · 55a232a · 55a232a
1 parent d575229
commit 55a232a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/actionpack/lib/action_dispatch/routing/mapper.rb b/actionpack/lib/action_dispatch/routing/mapper.rb
@@ -246,6 +246,8 @@ def initialize(set) #:nodoc:
         #
         #   root :to => 'pages#main'
         #
+        # For options, see the +match+ method's documentation, as +root+ uses it internally.
+        #
         # You should put the root route at the top of <tt>config/routes.rb</tt>,
         # because this means it will be matched first. As this is the most popular route
         # of most Rails applications, this is beneficial.