aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_controller/verification.rb
diff options
context:
space:
mode:
authorMarcel Molina <marcel@vernix.org>2007-11-06 23:33:40 +0000
committerMarcel Molina <marcel@vernix.org>2007-11-06 23:33:40 +0000
commit94502623fb8354ba0c88b9d1bc94bf940e0d5018 (patch)
tree3feef6b8342bac8a8f8ef3db5f051e536bce8a4f /actionpack/lib/action_controller/verification.rb
parent19d4c212cd35be37d67eb20bb4152356df96681b (diff)
downloadrails-94502623fb8354ba0c88b9d1bc94bf940e0d5018.tar.gz
rails-94502623fb8354ba0c88b9d1bc94bf940e0d5018.tar.bz2
rails-94502623fb8354ba0c88b9d1bc94bf940e0d5018.zip
Standardize on using hyphens rather than colons to separate option names from their explanation in documentation. Replace + with tt tags. Closes #8732. [ryanb]
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@8106 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'actionpack/lib/action_controller/verification.rb')
-rw-r--r--actionpack/lib/action_controller/verification.rb22
1 files changed, 11 insertions, 11 deletions
diff --git a/actionpack/lib/action_controller/verification.rb b/actionpack/lib/action_controller/verification.rb
index 43927408a9..8550f24526 100644
--- a/actionpack/lib/action_controller/verification.rb
+++ b/actionpack/lib/action_controller/verification.rb
@@ -42,32 +42,32 @@ module ActionController #:nodoc:
# the user is redirected to a different action. The +options+ parameter
# is a hash consisting of the following key/value pairs:
#
- # * <tt>:params</tt>: a single key or an array of keys that must
+ # * <tt>:params</tt> - a single key or an array of keys that must
# be in the <tt>params</tt> hash in order for the action(s) to be safely
# called.
- # * <tt>:session</tt>: a single key or an array of keys that must
+ # * <tt>:session</tt> - a single key or an array of keys that must
# be in the <tt>session</tt> in order for the action(s) to be safely called.
- # * <tt>:flash</tt>: a single key or an array of keys that must
+ # * <tt>:flash</tt> - a single key or an array of keys that must
# be in the flash in order for the action(s) to be safely called.
- # * <tt>:method</tt>: a single key or an array of keys--any one of which
+ # * <tt>:method</tt> - a single key or an array of keys--any one of which
# must match the current request method in order for the action(s) to
# be safely called. (The key should be a symbol: <tt>:get</tt> or
# <tt>:post</tt>, for example.)
- # * <tt>:xhr</tt>: true/false option to ensure that the request is coming
+ # * <tt>:xhr</tt> - true/false option to ensure that the request is coming
# from an Ajax call or not.
- # * <tt>:add_flash</tt>: a hash of name/value pairs that should be merged
+ # * <tt>:add_flash</tt> - a hash of name/value pairs that should be merged
# into the session's flash if the prerequisites cannot be satisfied.
- # * <tt>:add_headers</tt>: a hash of name/value pairs that should be
+ # * <tt>:add_headers</tt> - a hash of name/value pairs that should be
# merged into the response's headers hash if the prerequisites cannot
# be satisfied.
- # * <tt>:redirect_to</tt>: the redirection parameters to be used when
+ # * <tt>:redirect_to</tt> - the redirection parameters to be used when
# redirecting if the prerequisites cannot be satisfied. You can
# redirect either to named route or to the action in some controller.
- # * <tt>:render</tt>: the render parameters to be used when
+ # * <tt>:render</tt> - the render parameters to be used when
# the prerequisites cannot be satisfied.
- # * <tt>:only</tt>: only apply this verification to the actions specified
+ # * <tt>:only</tt> - only apply this verification to the actions specified
# in the associated array (may also be a single value).
- # * <tt>:except</tt>: do not apply this verification to the actions
+ # * <tt>:except</tt> - do not apply this verification to the actions
# specified in the associated array (may also be a single value).
def verify(options={})
filter_opts = { :only => options[:only], :except => options[:except] }