Django

Code

Changeset 184

Show
Ignore:
Timestamp:
07/18/05 15:53:02 (3 years ago)
Author:
adrian
Message:

Fixed #52 -- Corrected and clarified some things in docs/model-api. Thanks, Dobbes

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • django/trunk/docs/model-api.txt

    r136 r184  
    132132--------------------- 
    133133 
    134 Each type of field takes a different set of options, but some options are 
    135 common to all field types. These options are: 
     134Each type of field takes a different set of arguments, but some arguments are 
     135common to all field types. These arguments are: 
    136136 
    137137    ======================  =================================================== 
    138     Option                  Description 
     138    Argument                Description 
    139139    ======================  =================================================== 
    140140    ``blank``               If ``True``, the field is allowed to be blank. 
     
    241241 
    242242``CommaSeparatedIntegerField`` 
    243     A field of integers separated by commas. 
     243    A field of integers separated by commas. As in ``CharField``s, the 
     244    ``maxlength`` argument is required. 
    244245 
    245246``DateField`` 
    246     A date field. Has a few extra optional options: 
     247    A date field. Has a few extra optional arguments: 
    247248 
    248249        ======================  =================================================== 
    249         Option                  Description 
     250        Argument                Description 
    250251        ======================  =================================================== 
    251252        ``auto_now``            Automatically set the field to now every time the 
     
    275276 
    276277``FloatField`` 
    277     A floating-point number. Has two additional required options: 
     278    A floating-point number. Has two required arguments: 
    278279 
    279280        ======================  =================================================== 
    280         Option                  Description 
     281        Argument                Description 
    281282        ======================  =================================================== 
    282283        ``max_digits``          The maximum number of digits allowed in the number. 
     
    302303        meta.ForeignKey(Pizza) 
    303304 
    304     ``ForeignKey`` fields take a large number of extra options for defining how 
    305     the relationship should work
     305    ``ForeignKey`` fields take a large number of extra arguments for defining how 
     306    the relationship should work. All are optional
    306307 
    307308    =======================  ============================================================ 
    308     Option                   Description 
     309    Argument                 Description 
    309310    =======================  ============================================================ 
    310311    ``edit_inline``          If ``True``, this related object is edited 
     
    448449    aren't actually a field per se, because they use a intermediary join table. 
    449450    Second, they don't take any of the same options as the rest of the fields. 
    450     The only options taken are: 
     451    The only arguments taken are: 
    451452 
    452453    =======================  ============================================================ 
    453     Option                   Description 
     454    Argument                 Description 
    454455    =======================  ============================================================ 
    455456    ``related_name``         See the description of ``related_name`` in