diff options
author | Marcel Molina <marcel@vernix.org> | 2007-11-06 23:33:40 +0000 |
---|---|---|
committer | Marcel Molina <marcel@vernix.org> | 2007-11-06 23:33:40 +0000 |
commit | 94502623fb8354ba0c88b9d1bc94bf940e0d5018 (patch) | |
tree | 3feef6b8342bac8a8f8ef3db5f051e536bce8a4f /actionpack/lib/action_controller | |
parent | 19d4c212cd35be37d67eb20bb4152356df96681b (diff) | |
download | rails-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')
4 files changed, 27 insertions, 25 deletions
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: # - # * <tt>:success</tt>: Status code was 200 - # * <tt>:redirect</tt>: Status code was in the 300-399 range - # * <tt>:missing</tt>: Status code was 404 - # * <tt>:error</tt>: Status code was in the 500-599 range + # * <tt>:success</tt> - Status code was 200 + # * <tt>:redirect</tt> - Status code was in the 300-399 range + # * <tt>:missing</tt> - Status code was 404 + # * <tt>:error</tt> - 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 <tt>:replace</tt>, <tt>:replace_html</tt>, + # <tt>:show</tt>, <tt>:hide</tt>, <tt>:toggle</tt>, <tt>:remove</tt> and + # <tt>:insert_html</tt>. # - # Use the argument +:insert+ followed by an insertion position to narrow + # Use the argument <tt>:insert</tt> 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 <tt>:top</tt>, <tt>:bottom</tt>, <tt>:before</tt> + # and <tt>:after</tt>. # - # Using the +:remove+ statement, you will be able to pass a block, but it will + # Using the <tt>:remove</tt> 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: # - # * <tt>Hash</tt>: The URL will be generated by calling url_for with the +options+. - # * <tt>Record</tt>: The URL will be generated by calling url_for with the +options+, which will reference a named URL for that record. - # * <tt>String starting with protocol:// (like http://)</tt>: Is passed straight through as the target for redirection. - # * <tt>String not containing a protocol</tt>: The current protocol and host is prepended to the string. - # * <tt>:back</tt>: Back to the page that issued the request. Useful for forms that are triggered from multiple places. + # * <tt>Hash</tt> - The URL will be generated by calling url_for with the +options+. + # * <tt>Record</tt> - The URL will be generated by calling url_for with the +options+, which will reference a named URL for that record. + # * <tt>String starting with protocol:// (like http://)</tt> - Is passed straight through as the target for redirection. + # * <tt>String not containing a protocol</tt> - The current protocol and host is prepended to the string. + # * <tt>:back</tt> - 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: # - # * <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] } |