Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Fixed #52 -- Corrected and clarified some things in docs/model-api. T…

…hanks, Dobbes

git-svn-id: http://code.djangoproject.com/svn/django/trunk@184 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 34f749e506b6e0748809ba71e877082cf5eedd21 1 parent a7237aa
Adrian Holovaty authored July 18, 2005

Showing 1 changed file with 14 additions and 13 deletions. Show diff stats Hide diff stats

  1. 27  docs/model-api.txt
27  docs/model-api.txt
@@ -131,11 +131,11 @@ contain spaces, punctuation, etc.
131 131
 General field options
132 132
 ---------------------
133 133
 
134  
-Each type of field takes a different set of options, but some options are
135  
-common to all field types. These options are:
  134
+Each type of field takes a different set of arguments, but some arguments are
  135
+common to all field types. These arguments are:
136 136
 
137 137
     ======================  ===================================================
138  
-    Option                  Description
  138
+    Argument                Description
139 139
     ======================  ===================================================
140 140
     ``blank``               If ``True``, the field is allowed to be blank.
141 141
                             Note that this is different from ``null`` in that
@@ -240,13 +240,14 @@ Field Types
240 240
     level and in Django's admin validation.
241 241
 
242 242
 ``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.
244 245
 
245 246
 ``DateField``
246  
-    A date field. Has a few extra optional options:
  247
+    A date field. Has a few extra optional arguments:
247 248
 
248 249
         ======================  ===================================================
249  
-        Option                  Description
  250
+        Argument                Description
250 251
         ======================  ===================================================
251 252
         ``auto_now``            Automatically set the field to now every time the
252 253
                                 object is saved. Useful for "last-modified"
@@ -274,10 +275,10 @@ Field Types
274 275
     .. _`strftime formatting`: http://docs.python.org/lib/module-time.html#l2h-1941
275 276
 
276 277
 ``FloatField``
277  
-    A floating-point number. Has two additional required options:
  278
+    A floating-point number. Has two required arguments:
278 279
 
279 280
         ======================  ===================================================
280  
-        Option                  Description
  281
+        Argument                Description
281 282
         ======================  ===================================================
282 283
         ``max_digits``          The maximum number of digits allowed in the number.
283 284
 
@@ -301,11 +302,11 @@ Field Types
301 302
 
302 303
         meta.ForeignKey(Pizza)
303 304
 
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:
306 307
 
307 308
     =======================  ============================================================
308  
-    Option                   Description
  309
+    Argument                 Description
309 310
     =======================  ============================================================
310 311
     ``edit_inline``          If ``True``, this related object is edited
311 312
                              "inline" on the related object's page. This means
@@ -447,10 +448,10 @@ Field Types
447 448
     Many-to-many relations are a bit different from other fields.  First, they
448 449
     aren't actually a field per se, because they use a intermediary join table.
449 450
     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:
451 452
 
452 453
     =======================  ============================================================
453  
-    Option                   Description
  454
+    Argument                 Description
454 455
     =======================  ============================================================
455 456
     ``related_name``         See the description of ``related_name`` in
456 457
                              ``ManyToOneField``, above.

0 notes on commit 34f749e

Please sign in to comment.
Something went wrong with that request. Please try again.