diff options
| author | Marko Tibold | 2012-10-22 20:09:36 +0200 |
|---|---|---|
| committer | Marko Tibold | 2012-10-22 20:09:36 +0200 |
| commit | d1e05ea8d4b5d7f94bde9a574196505aa823a6ff (patch) | |
| tree | cf155b8a239644243d8198c69ec15070627b4ed8 /docs | |
| parent | ab1a12bfecf49061cb31dff05add26d96078771e (diff) | |
| parent | 95a670de41a246777bc1e448dca8cc576b7b86ea (diff) | |
| download | django-rest-framework-d1e05ea8d4b5d7f94bde9a574196505aa823a6ff.tar.bz2 | |
Merge commit '95a670de41a246777bc1e448dca8cc576b7b86ea' into BrowsableAPIRenderer
Conflicts:
rest_framework/renderers.py - manually resolved conflict
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-guide/fields.md | 34 |
1 files changed, 26 insertions, 8 deletions
diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index b3cf186c..189ed76f 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -73,34 +73,52 @@ These fields represent basic datatypes, and support both reading and writing val ## BooleanField -A Boolean representation, corresponds to `django.db.models.fields.BooleanField`. +A Boolean representation. + +Corresponds to `django.db.models.fields.BooleanField`. ## CharField -A text representation, optionally validates the text to be shorter than `max_length` and longer than `min_length`, corresponds to `django.db.models.fields.CharField` +A text representation, optionally validates the text to be shorter than `max_length` and longer than `min_length`. + +Corresponds to `django.db.models.fields.CharField` or `django.db.models.fields.TextField`. -**Signature:** `CharField([max_length=<Integer>[, min_length=<Integer>]])` +**Signature:** `CharField(max_length=None, min_length=None)` + +## ChoiceField + +A field that can accept on of a limited set of choices. ## EmailField -A text representation, validates the text to be a valid e-mail address. Corresponds to `django.db.models.fields.EmailField` +A text representation, validates the text to be a valid e-mail address. + +Corresponds to `django.db.models.fields.EmailField` ## DateField -A date representation. Corresponds to `django.db.models.fields.DateField` +A date representation. + +Corresponds to `django.db.models.fields.DateField` ## DateTimeField -A date and time representation. Corresponds to `django.db.models.fields.DateTimeField` +A date and time representation. + +Corresponds to `django.db.models.fields.DateTimeField` ## IntegerField -An integer representation. Corresponds to `django.db.models.fields.IntegerField`, `django.db.models.fields.SmallIntegerField`, `django.db.models.fields.PositiveIntegerField` and `django.db.models.fields.PositiveSmallIntegerField` +An integer representation. + +Corresponds to `django.db.models.fields.IntegerField`, `django.db.models.fields.SmallIntegerField`, `django.db.models.fields.PositiveIntegerField` and `django.db.models.fields.PositiveSmallIntegerField` ## FloatField -A floating point representation. Corresponds to `django.db.models.fields.FloatField`. +A floating point representation. + +Corresponds to `django.db.models.fields.FloatField`. --- |
