Permalink
Browse files

Turned options into rdoc-lists in AR::Base

  • Loading branch information...
1 parent 0ec7c0a commit 67ebf14a91ffd970b582be4ff2991d691a9cf3e1 @sunny sunny committed May 5, 2008
Showing with 22 additions and 22 deletions.
  1. +22 −22 activerecord/lib/active_record/base.rb
@@ -628,8 +628,8 @@ def create(attributes = nil, &block)
#
# ==== Options
#
- # +id+ This should be the id or an array of ids to be updated
- # +attributes+ This should be a Hash of attributes to be set on the object, or an array of Hashes.
+ # * +id+ This should be the id or an array of ids to be updated
+ # * +attributes+ This should be a Hash of attributes to be set on the object, or an array of Hashes.
#
# ==== Examples
#
@@ -658,7 +658,7 @@ def update(id, attributes)
#
# ==== Options
#
- # +id+ Can be either an Integer or an Array of Integers
+ # * +id+ Can be either an Integer or an Array of Integers
#
# ==== Examples
#
@@ -681,7 +681,7 @@ def delete(id)
#
# ==== Options
#
- # +id+ Can be either an Integer or an Array of Integers
+ # * +id+ Can be either an Integer or an Array of Integers
#
# ==== Examples
#
@@ -704,10 +704,10 @@ def destroy(id)
#
# ==== Options
#
- # +updates+ A String of column and value pairs that will be set on any records that match conditions
- # +conditions+ An SQL fragment like "administrator = 1" or [ "user_name = ?", username ].
- # See conditions in the intro for more info.
- # +options+ Additional options are <tt>:limit</tt> and/or <tt>:order</tt>, see the examples for usage.
+ # * +updates+ A String of column and value pairs that will be set on any records that match conditions
+ # * +conditions+ An SQL fragment like "administrator = 1" or [ "user_name = ?", username ].
+ # See conditions in the intro for more info.
+ # * +options+ Additional options are <tt>:limit</tt> and/or <tt>:order</tt>, see the examples for usage.
#
# ==== Examples
#
@@ -736,7 +736,7 @@ def update_all(updates, conditions = nil, options = {})
#
# ==== Options
#
- # +conditions+ Conditions are specified the same way as with +find+ method.
+ # * +conditions+ Conditions are specified the same way as with +find+ method.
#
# ==== Example
#
@@ -754,7 +754,7 @@ def destroy_all(conditions = nil)
#
# ==== Options
#
- # +conditions+ Conditions are specified the same way as with +find+ method.
+ # * +conditions+ Conditions are specified the same way as with +find+ method.
#
# ==== Example
#
@@ -774,7 +774,7 @@ def delete_all(conditions = nil)
#
# ==== Options
#
- # +sql+: An SQL statement which should return a count query from the database, see the example below
+ # * +sql+ An SQL statement which should return a count query from the database, see the example below
#
# ==== Examples
#
@@ -792,10 +792,10 @@ def count_by_sql(sql)
#
# ==== Options
#
- # +id+ The id of the object you wish to update a counter on
- # +counters+ An Array of Hashes containing the names of the fields
- # to update as keys and the amount to update the field by as
- # values
+ # * +id+ The id of the object you wish to update a counter on
+ # * +counters+ An Array of Hashes containing the names of the fields
+ # to update as keys and the amount to update the field by as
+ # values
#
# ==== Examples
#
@@ -823,8 +823,8 @@ def update_counters(id, counters)
#
# ==== Options
#
- # +counter_name+ The name of the field that should be incremented
- # +id+ The id of the object that should be incremented
+ # * +counter_name+ The name of the field that should be incremented
+ # * +id+ The id of the object that should be incremented
#
# ==== Examples
#
@@ -840,8 +840,8 @@ def increment_counter(counter_name, id)
#
# ==== Options
#
- # +counter_name+ The name of the field that should be decremented
- # +id+ The id of the object that should be decremented
+ # * +counter_name+ The name of the field that should be decremented
+ # * +id+ The id of the object that should be decremented
#
# ==== Examples
#
@@ -888,7 +888,7 @@ def protected_attributes # :nodoc:
#
# ==== Options
#
- # <tt>*attributes</tt> A comma separated list of symbols that represent columns _not_ to be protected
+ # * <tt>*attributes</tt> A comma separated list of symbols that represent columns _not_ to be protected
#
# ==== Examples
#
@@ -929,8 +929,8 @@ def readonly_attributes
#
# ==== Options
#
- # +attr_name+ The field name that should be serialized
- # +class_name+ Optional, class name that the object type should be equal to
+ # * +attr_name+ The field name that should be serialized
+ # * +class_name+ Optional, class name that the object type should be equal to
#
# ==== Example
# # Serialize a preferences attribute

0 comments on commit 67ebf14

Please sign in to comment.