From 94502623fb8354ba0c88b9d1bc94bf940e0d5018 Mon Sep 17 00:00:00 2001 From: Marcel Molina Date: Tue, 6 Nov 2007 23:33:40 +0000 Subject: 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 --- .../assertions/response_assertions.rb | 8 ++++---- .../assertions/selector_assertions.rb | 12 +++++++----- actionpack/lib/action_controller/base.rb | 10 +++++----- actionpack/lib/action_controller/verification.rb | 22 +++++++++++----------- 4 files changed, 27 insertions(+), 25 deletions(-) (limited to 'actionpack/lib/action_controller') diff --git a/actionpack/lib/action_controller/assertions/response_assertions.rb b/actionpack/lib/action_controller/assertions/response_assertions.rb index 09fb4f9a1b..29eb2b033a 100644 --- a/actionpack/lib/action_controller/assertions/response_assertions.rb +++ b/actionpack/lib/action_controller/assertions/response_assertions.rb @@ -6,10 +6,10 @@ module ActionController module ResponseAssertions # Asserts that the response is one of the following types: # - # * :success: Status code was 200 - # * :redirect: Status code was in the 300-399 range - # * :missing: Status code was 404 - # * :error: Status code was in the 500-599 range + # * :success - Status code was 200 + # * :redirect - Status code was in the 300-399 range + # * :missing - Status code was 404 + # * :error - Status code was in the 500-599 range # # You can also pass an explicit status number like assert_response(501) # or its symbolic equivalent assert_response(:not_implemented). diff --git a/actionpack/lib/action_controller/assertions/selector_assertions.rb b/actionpack/lib/action_controller/assertions/selector_assertions.rb index 9103670742..f70186fe17 100644 --- a/actionpack/lib/action_controller/assertions/selector_assertions.rb +++ b/actionpack/lib/action_controller/assertions/selector_assertions.rb @@ -326,14 +326,16 @@ module ActionController # that update or insert an element with that identifier. # # Use the first argument to narrow down assertions to only statements - # of that type. Possible values are +:replace+, +:replace_html+, +:show+, - # +:hide+, +:toggle+, +:remove+ and +:insert_html+. + # of that type. Possible values are :replace, :replace_html, + # :show, :hide, :toggle, :remove and + # :insert_html. # - # Use the argument +:insert+ followed by an insertion position to narrow + # Use the argument :insert followed by an insertion position to narrow # down the assertion to only statements that insert elements in that - # position. Possible values are +:top+, +:bottom+, +:before+ and +:after+. + # position. Possible values are :top, :bottom, :before + # and :after. # - # Using the +:remove+ statement, you will be able to pass a block, but it will + # Using the :remove statement, you will be able to pass a block, but it will # be ignored as there is no HTML passed for this statement. # # === Using blocks diff --git a/actionpack/lib/action_controller/base.rb b/actionpack/lib/action_controller/base.rb index 662aa09bb6..07fed278e2 100755 --- a/actionpack/lib/action_controller/base.rb +++ b/actionpack/lib/action_controller/base.rb @@ -982,11 +982,11 @@ module ActionController #:nodoc: # Redirects the browser to the target specified in +options+. This parameter can take one of three forms: # - # * Hash: The URL will be generated by calling url_for with the +options+. - # * Record: The URL will be generated by calling url_for with the +options+, which will reference a named URL for that record. - # * String starting with protocol:// (like http://): Is passed straight through as the target for redirection. - # * String not containing a protocol: The current protocol and host is prepended to the string. - # * :back: Back to the page that issued the request. Useful for forms that are triggered from multiple places. + # * Hash - The URL will be generated by calling url_for with the +options+. + # * Record - The URL will be generated by calling url_for with the +options+, which will reference a named URL for that record. + # * String starting with protocol:// (like http://) - Is passed straight through as the target for redirection. + # * String not containing a protocol - The current protocol and host is prepended to the string. + # * :back - Back to the page that issued the request. Useful for forms that are triggered from multiple places. # Short-hand for redirect_to(request.env["HTTP_REFERER"]) # # Examples: 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: # - # * :params: a single key or an array of keys that must + # * :params - a single key or an array of keys that must # be in the params hash in order for the action(s) to be safely # called. - # * :session: a single key or an array of keys that must + # * :session - a single key or an array of keys that must # be in the session in order for the action(s) to be safely called. - # * :flash: a single key or an array of keys that must + # * :flash - a single key or an array of keys that must # be in the flash in order for the action(s) to be safely called. - # * :method: a single key or an array of keys--any one of which + # * :method - 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: :get or # :post, for example.) - # * :xhr: true/false option to ensure that the request is coming + # * :xhr - true/false option to ensure that the request is coming # from an Ajax call or not. - # * :add_flash: a hash of name/value pairs that should be merged + # * :add_flash - a hash of name/value pairs that should be merged # into the session's flash if the prerequisites cannot be satisfied. - # * :add_headers: a hash of name/value pairs that should be + # * :add_headers - a hash of name/value pairs that should be # merged into the response's headers hash if the prerequisites cannot # be satisfied. - # * :redirect_to: the redirection parameters to be used when + # * :redirect_to - 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. - # * :render: the render parameters to be used when + # * :render - the render parameters to be used when # the prerequisites cannot be satisfied. - # * :only: only apply this verification to the actions specified + # * :only - only apply this verification to the actions specified # in the associated array (may also be a single value). - # * :except: do not apply this verification to the actions + # * :except - 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] } -- cgit v1.2.3