Merge pull request #1543 from joliss/doc

Improve routing API docs
This commit is contained in:
Carlos Antonio da Silva 2012-01-03 06:39:41 -08:00
commit f4bbad6323
1 changed files with 7 additions and 6 deletions

View File

@ -84,8 +84,9 @@ module ActionDispatch::Routing
# #
# You need to make sure that your sign_out controls trigger a request with a matching HTTP method. # You need to make sure that your sign_out controls trigger a request with a matching HTTP method.
# #
# * :module => the namespace to find controlers. By default, devise will access devise/sessions, # * :module => the namespace to find controllers (default: "devise", thus
# devise/registrations and so on. If you want to namespace all at once, use module: # accessing devise/sessions, devise/registrations, and so on). If you want
# to namespace all at once, use module:
# #
# devise_for :users, :module => "users" # devise_for :users, :module => "users"
# #
@ -135,15 +136,15 @@ module ActionDispatch::Routing
# devise_for :users # devise_for :users
# end # end
# #
# However, since Devise uses the request path to retrieve the current user, it has one caveats. # However, since Devise uses the request path to retrieve the current user,
# If you are using a dynamic segment, as below: # this has one caveat: If you are using a dynamic segment, like so ...
# #
# scope ":locale" do # scope ":locale" do
# devise_for :users # devise_for :users
# end # end
# #
# You are required to configure default_url_options in your ApplicationController class level, so # you are required to configure default_url_options in your
# Devise can pick it: # ApplicationController class, so Devise can pick it:
# #
# class ApplicationController < ActionController::Base # class ApplicationController < ActionController::Base
# def self.default_url_options # def self.default_url_options