public
Description: PLEASE CHECK http://github.com/lifo/docrails/wikis
Homepage: http://weblog.rubyonrails.org/2008/5/2/help-improve-rails-documentation-on-git-branch
Clone URL: git://github.com/lifo/docrails.git
Applied list conventions in AR::Base
sunny (author)
Wed May 07 05:00:59 -0700 2008
commit  370f4f51722cec49ace17093d29e9ce9e8f15cfb
tree    193130f4f40ef614a0948a2bafc8c7c83f9f900b
parent  5bd18429f09d44e75191bec42a6db04bd33f3030
...
633
634
635
636
637
 
 
638
639
640
...
663
664
665
666
 
667
668
669
...
686
687
688
689
 
690
691
692
...
709
710
711
712
713
714
715
 
 
 
 
716
717
718
...
741
742
743
744
 
745
746
747
...
759
760
761
762
 
763
764
765
...
779
780
781
782
 
783
784
785
...
797
798
799
800
801
802
803
 
 
 
804
805
806
...
828
829
830
831
832
 
 
833
834
835
...
845
846
847
848
849
 
 
850
851
852
...
934
935
936
937
938
 
 
939
940
941
...
633
634
635
 
 
636
637
638
639
640
...
663
664
665
 
666
667
668
669
...
686
687
688
 
689
690
691
692
...
709
710
711
 
 
 
 
712
713
714
715
716
717
718
...
741
742
743
 
744
745
746
747
...
759
760
761
 
762
763
764
765
...
779
780
781
 
782
783
784
785
...
797
798
799
 
 
 
 
800
801
802
803
804
805
...
827
828
829
 
 
830
831
832
833
834
...
844
845
846
 
 
847
848
849
850
851
...
933
934
935
 
 
936
937
938
939
940
0
@@ -633,8 +633,8 @@ module ActiveRecord #:nodoc:
0
       #
0
       # ==== Attributes
0
       #
0
- # * +id+ This should be the id or an array of ids to be updated
0
- # * +attributes+ This should be a Hash of attributes to be set on the object, or an array of Hashes.
0
+ # * +id+ - This should be the id or an array of ids to be updated.
0
+ # * +attributes+ - This should be a Hash of attributes to be set on the object, or an array of Hashes.
0
       #
0
       # ==== Examples
0
       #
0
@@ -663,7 +663,7 @@ module ActiveRecord #:nodoc:
0
       #
0
       # ==== Attributes
0
       #
0
- # * +id+ Can be either an Integer or an Array of Integers
0
+ # * +id+ - Can be either an Integer or an Array of Integers.
0
       #
0
       # ==== Examples
0
       #
0
@@ -686,7 +686,7 @@ module ActiveRecord #:nodoc:
0
       #
0
       # ==== Attributes
0
       #
0
- # * +id+ Can be either an Integer or an Array of Integers
0
+ # * +id+ - Can be either an Integer or an Array of Integers.
0
       #
0
       # ==== Examples
0
       #
0
@@ -709,10 +709,10 @@ module ActiveRecord #:nodoc:
0
       #
0
       # ==== Attributes
0
       #
0
- # * +updates+ A String of column and value pairs that will be set on any records that match conditions
0
- # * +conditions+ An SQL fragment like "administrator = 1" or [ "user_name = ?", username ].
0
- # See conditions in the intro for more info.
0
- # * +options+ Additional options are <tt>:limit</tt> and/or <tt>:order</tt>, see the examples for usage.
0
+ # * +updates+ - A String of column and value pairs that will be set on any records that match conditions.
0
+ # * +conditions+ - An SQL fragment like "administrator = 1" or [ "user_name = ?", username ].
0
+ # See conditions in the intro for more info.
0
+ # * +options+ - Additional options are <tt>:limit</tt> and/or <tt>:order</tt>, see the examples for usage.
0
       #
0
       # ==== Examples
0
       #
0
@@ -741,7 +741,7 @@ module ActiveRecord #:nodoc:
0
       #
0
       # ==== Attributes
0
       #
0
- # * +conditions+ Conditions are specified the same way as with +find+ method.
0
+ # * +conditions+ - Conditions are specified the same way as with +find+ method.
0
       #
0
       # ==== Example
0
       #
0
@@ -759,7 +759,7 @@ module ActiveRecord #:nodoc:
0
       #
0
       # ==== Attributes
0
       #
0
- # * +conditions+ Conditions are specified the same way as with +find+ method.
0
+ # * +conditions+ - Conditions are specified the same way as with +find+ method.
0
       #
0
       # ==== Example
0
       #
0
@@ -779,7 +779,7 @@ module ActiveRecord #:nodoc:
0
       #
0
       # ==== Attributes
0
       #
0
- # * +sql+ An SQL statement which should return a count query from the database, see the example below
0
+ # * +sql+ - An SQL statement which should return a count query from the database, see the example below.
0
       #
0
       # ==== Examples
0
       #
0
@@ -797,10 +797,9 @@ module ActiveRecord #:nodoc:
0
       #
0
       # ==== Attributes
0
       #
0
- # * +id+ The id of the object you wish to update a counter on
0
- # * +counters+ An Array of Hashes containing the names of the fields
0
- # to update as keys and the amount to update the field by as
0
- # values
0
+ # * +id+ - The id of the object you wish to update a counter on.
0
+ # * +counters+ - An Array of Hashes containing the names of the fields
0
+ # to update as keys and the amount to update the field by as values.
0
       #
0
       # ==== Examples
0
       #
0
@@ -828,8 +827,8 @@ module ActiveRecord #:nodoc:
0
       #
0
       # ==== Attributes
0
       #
0
- # * +counter_name+ The name of the field that should be incremented
0
- # * +id+ The id of the object that should be incremented
0
+ # * +counter_name+ - The name of the field that should be incremented.
0
+ # * +id+ - The id of the object that should be incremented.
0
       #
0
       # ==== Examples
0
       #
0
@@ -845,8 +844,8 @@ module ActiveRecord #:nodoc:
0
       #
0
       # ==== Attributes
0
       #
0
- # * +counter_name+ The name of the field that should be decremented
0
- # * +id+ The id of the object that should be decremented
0
+ # * +counter_name+ - The name of the field that should be decremented.
0
+ # * +id+ - The id of the object that should be decremented.
0
       #
0
       # ==== Examples
0
       #
0
@@ -934,8 +933,8 @@ module ActiveRecord #:nodoc:
0
       #
0
       # ==== Attributes
0
       #
0
- # * +attr_name+ The field name that should be serialized
0
- # * +class_name+ Optional, class name that the object type should be equal to
0
+ # * +attr_name+ - The field name that should be serialized.
0
+ # * +class_name+ - Optional, class name that the object type should be equal to.
0
       #
0
       # ==== Example
0
       # # Serialize a preferences attribute

Comments

    No one has commented yet.