Permalink
Browse files

revised some conventions in url_helper.rb

  • Loading branch information...
1 parent 17d22e9 commit 3e7bd63ec5bd60d39145b480339c17b8a5c45273 @fxn fxn committed May 4, 2008
Showing with 14 additions and 14 deletions.
  1. +14 −14 actionpack/lib/action_view/helpers/url_helper.rb
@@ -19,15 +19,15 @@ module UrlHelper
# need an unescaped url, pass <tt>:escape => false</tt> in the +options+.
#
# ==== Options
- # * <tt>:anchor</tt> -- specifies the anchor name to be appended to the path.
- # * <tt>:only_path</tt> -- if true, returns the relative URL (omitting the protocol, host name, and port) (<tt>true</tt> by default unless <tt>:host</tt> is specified)
- # * <tt>:trailing_slash</tt> -- if true, adds a trailing slash, as in "/archive/2005/". Note that this
+ # * <tt>:anchor</tt> - Specifies the anchor name to be appended to the path.
+ # * <tt>:only_path</tt> - If true, returns the relative URL (omitting the protocol, host name, and port) (<tt>true</tt> by default unless <tt>:host</tt> is specified).
+ # * <tt>:trailing_slash</tt> - If true, adds a trailing slash, as in "/archive/2005/". Note that this
# is currently not recommended since it breaks caching.
- # * <tt>:host</tt> -- overrides the default (current) host if provided
- # * <tt>:protocol</tt> -- overrides the default (current) protocol if provided
- # * <tt>:user</tt> -- Inline HTTP authentication (only plucked out if <tt>:password</tt> is also present)
- # * <tt>:password</tt> -- Inline HTTP authentication (only plucked out if <tt>:user</tt> is also present)
- # * <tt>:escape</tt> -- Determines whether the returned URL will be HTML escaped or not (<tt>true</tt> by default)
+ # * <tt>:host</tt> - Overrides the default (current) host if provided.
+ # * <tt>:protocol</tt> - Overrides the default (current) protocol if provided.
+ # * <tt>:user</tt> - Inline HTTP authentication (only plucked out if <tt>:password</tt> is also present).
+ # * <tt>:password</tt> - Inline HTTP authentication (only plucked out if <tt>:user</tt> is also present).
+ # * <tt>:escape</tt> - Determines whether the returned URL will be HTML escaped or not (<tt>true</tt> by default).
#
# ==== Relying on named routes
#
@@ -91,14 +91,14 @@ def url_for(options = {})
# a name, the link itself will become the name.
#
# ==== Options
- # * <tt>:confirm => 'question?'</tt> -- This will add a JavaScript confirm
+ # * <tt>:confirm => 'question?'</tt> - This will add a JavaScript confirm
# prompt with the question specified. If the user accepts, the link is
# processed normally, otherwise no action is taken.
- # * <tt>:popup => true || array of window options</tt> -- This will force the
+ # * <tt>:popup => true || array of window options</tt> - This will force the
# link to open in a popup window. By passing true, a default browser window
# will be opened with the URL. You can also specify an array of options
# that are passed-thru to JavaScripts window.open method.
- # * <tt>:method => symbol of HTTP verb</tt> -- This modifier will dynamically
+ # * <tt>:method => symbol of HTTP verb</tt> - This modifier will dynamically
# create an HTML form and immediately submit the form for processing using
# the HTTP verb specified. Useful for having links perform a POST operation
# in dangerous actions like deleting a record (which search bots can follow
@@ -178,9 +178,9 @@ def link_to(name, options = {}, html_options = nil)
# The +options+ hash accepts the same options at url_for.
#
# There are a few special +html_options+:
- # * <tt>:method</tt> -- specifies the anchor name to be appended to the path.
- # * <tt>:disabled</tt> -- specifies the anchor name to be appended to the path.
- # * <tt>:confirm</tt> -- This will add a JavaScript confirm
+ # * <tt>:method</tt> - Specifies the anchor name to be appended to the path.
+ # * <tt>:disabled</tt> - Specifies the anchor name to be appended to the path.
+ # * <tt>:confirm</tt> - This will add a JavaScript confirm
# prompt with the question specified. If the user accepts, the link is
# processed normally, otherwise no action is taken.
#

0 comments on commit 3e7bd63

Please sign in to comment.