From 03e68ec80f393ee3b7ea0276b074268c90e722cf Mon Sep 17 00:00:00 2001 From: Xavier Noria Date: Sun, 4 May 2008 23:05:57 +0200 Subject: revised conventions for lists of options in action_controller/base.rb --- actionpack/lib/action_controller/base.rb | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/actionpack/lib/action_controller/base.rb b/actionpack/lib/action_controller/base.rb index 6b5914c4dd..35c6e19ad8 100755 --- a/actionpack/lib/action_controller/base.rb +++ b/actionpack/lib/action_controller/base.rb @@ -535,20 +535,20 @@ module ActionController #:nodoc: # # url_for is used to: # - # All keys given to url_for are forwarded to the Route module, save for the following: - # * :anchor -- specifies the anchor name to be appended to the path. For example, + # All keys given to +url_for+ are forwarded to the Route module, save for the following: + # * :anchor - Specifies the anchor name to be appended to the path. For example, # url_for :controller => 'posts', :action => 'show', :id => 10, :anchor => 'comments' # will produce "/posts/show/10#comments". - # * :only_path -- if true, returns the relative URL (omitting the protocol, host name, and port) (false by default) - # * :trailing_slash -- if true, adds a trailing slash, as in "/archive/2005/". Note that this + # * :only_path - If true, returns the relative URL (omitting the protocol, host name, and port) (false by default). + # * :trailing_slash - If true, adds a trailing slash, as in "/archive/2005/". Note that this # is currently not recommended since it breaks caching. - # * :host -- overrides the default (current) host if provided. - # * :protocol -- overrides the default (current) protocol if provided. - # * :port -- optionally specify the port to connect to. - # * :user -- Inline HTTP authentication (only plucked out if :password is also present). - # * :password -- Inline HTTP authentication (only plucked out if :user is also present). - # * :skip_relative_url_root -- if true, the url is not constructed using the relative_url_root of the request so the path - # will include the web server relative installation directory. + # * :host - Overrides the default (current) host if provided. + # * :protocol - Overrides the default (current) protocol if provided. + # * :port - Optionally specify the port to connect to. + # * :user - Inline HTTP authentication (only plucked out if :password is also present). + # * :password - Inline HTTP authentication (only plucked out if :user is also present). + # * :skip_relative_url_root - If true, the url is not constructed using the +relative_url_root+ + # of the request so the path will include the web server relative installation directory. # # The URL is generated from the remaining keys in the hash. A URL contains two key parts: the and a query string. # Routes composes a query string as the key/value pairs not included in the . -- cgit v1.2.3