Permalink
Browse files

revised conventions in resources.rb

  • Loading branch information...
1 parent 238acc8 commit 8d78ac598c87887eb9d0b4c77ca69eb1bb279472 @fxn fxn committed May 5, 2008
Showing with 17 additions and 17 deletions.
  1. +17 −17 actionpack/lib/action_controller/resources.rb
@@ -236,27 +236,27 @@ def initialize(entity, options)
# which takes into account whether <tt>@message</tt> is a new record or not and generates the
# path and method accordingly.
#
- # The #resources method accepts the following options to customize the resulting routes:
- # * <tt>:collection</tt> - add named routes for other actions that operate on the collection.
+ # The +resources+ method accepts the following options to customize the resulting routes:
+ # * <tt>:collection</tt> - Add named routes for other actions that operate on the collection.
# Takes a hash of <tt>#{action} => #{method}</tt>, where method is <tt>:get</tt>/<tt>:post</tt>/<tt>:put</tt>/<tt>:delete</tt>
- # or <tt>:any</tt> if the method does not matter. These routes map to a URL like /messages/rss, with a route of rss_messages_url.
- # * <tt>:member</tt> - same as <tt>:collection</tt>, but for actions that operate on a specific member.
- # * <tt>:new</tt> - same as <tt>:collection</tt>, but for actions that operate on the new resource action.
- # * <tt>:controller</tt> - specify the controller name for the routes.
- # * <tt>:singular</tt> - specify the singular name used in the member routes.
- # * <tt>:requirements</tt> - set custom routing parameter requirements.
- # * <tt>:conditions</tt> - specify custom routing recognition conditions. Resources sets the <tt>:method</tt> value for the method-specific routes.
- # * <tt>:as</tt> - specify a different resource name to use in the URL path. For example:
+ # or <tt>:any</tt> if the method does not matter. These routes map to a URL like /messages/rss, with a route of +rss_messages_url+.
+ # * <tt>:member</tt> - Same as <tt>:collection</tt>, but for actions that operate on a specific member.
+ # * <tt>:new</tt> - Same as <tt>:collection</tt>, but for actions that operate on the new resource action.
+ # * <tt>:controller</tt> - Specify the controller name for the routes.
+ # * <tt>:singular</tt> - Specify the singular name used in the member routes.
+ # * <tt>:requirements</tt> - Set custom routing parameter requirements.
+ # * <tt>:conditions</tt> - Specify custom routing recognition conditions. Resources sets the <tt>:method</tt> value for the method-specific routes.
+ # * <tt>:as</tt> - Specify a different resource name to use in the URL path. For example:
# # products_path == '/productos'
# map.resources :products, :as => 'productos' do |product|
# # product_reviews_path(product) == '/productos/1234/comentarios'
# product.resources :product_reviews, :as => 'comentarios'
# end
#
- # * <tt>:has_one</tt> - specify nested resources, this is a shorthand for mapping singleton resources beneath the current.
- # * <tt>:has_many</tt> - same has <tt>:has_one</tt>, but for plural resources.
+ # * <tt>:has_one</tt> - Specify nested resources, this is a shorthand for mapping singleton resources beneath the current.
+ # * <tt>:has_many</tt> - Same has <tt>:has_one</tt>, but for plural resources.
#
- # You may directly specify the routing association with has_one and has_many like:
+ # You may directly specify the routing association with +has_one+ and +has_many+ like:
#
# map.resources :notes, :has_one => :author, :has_many => [:comments, :attachments]
#
@@ -268,14 +268,14 @@ def initialize(entity, options)
# notes.resources :attachments
# end
#
- # * <tt>:path_names</tt> - specify different names for the 'new' and 'edit' actions. For example:
+ # * <tt>:path_names</tt> - Specify different names for the 'new' and 'edit' actions. For example:
# # new_products_path == '/productos/nuevo'
# map.resources :products, :as => 'productos', :path_names => { :new => 'nuevo', :edit => 'editar' }
#
# You can also set default action names from an environment, like this:
# config.action_controller.resources_path_names = { :new => 'nuevo', :edit => 'editar' }
#
- # * <tt>:path_prefix</tt> - set a prefix to the routes with required route variables.
+ # * <tt>:path_prefix</tt> - Set a prefix to the routes with required route variables.
#
# Weblog comments usually belong to a post, so you might use resources like:
#
@@ -296,7 +296,7 @@ def initialize(entity, options)
# article_comments_url(:article_id => @article)
# article_comment_url(:article_id => @article, :id => @comment)
#
- # * <tt>:name_prefix</tt> - define a prefix for all generated routes, usually ending in an underscore.
+ # * <tt>:name_prefix</tt> - Define a prefix for all generated routes, usually ending in an underscore.
# Use this if you have named routes that may clash.
#
# map.resources :tags, :path_prefix => '/books/:book_id', :name_prefix => 'book_'
@@ -343,7 +343,7 @@ def initialize(entity, options)
# # --> GET /categories/7/messages/1
# # has named route "category_message"
#
- # The #resources method sets HTTP method restrictions on the routes it generates. For example, making an
+ # The +resources+ method sets HTTP method restrictions on the routes it generates. For example, making an
# HTTP POST on <tt>new_message_url</tt> will raise a RoutingError exception. The default route in
# <tt>config/routes.rb</tt> overrides this and allows invalid HTTP methods for resource routes.
def resources(*entities, &block)

0 comments on commit 8d78ac5

Please sign in to comment.