diff options
| author | Tom Christie | 2014-12-09 14:21:31 +0000 | 
|---|---|---|
| committer | Tom Christie | 2014-12-09 14:21:31 +0000 | 
| commit | f5b783af617f507efbc0d5ede0d27bd6be903d63 (patch) | |
| tree | 92c6d5a5434d7849b85af9a319dc4e926f4aeb0d | |
| parent | 54a18a4ddb69bb43c13e45f151b075564dd771b2 (diff) | |
| download | django-rest-framework-f5b783af617f507efbc0d5ede0d27bd6be903d63.tar.bz2 | |
allow_blank in ChoiceField. Refs #2239.
| -rw-r--r-- | docs/api-guide/fields.md | 6 | 
1 files changed, 6 insertions, 0 deletions
| diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index aa5cc84e..e4ef1d4a 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -310,6 +310,9 @@ Used by `ModelSerializer` to automatically generate fields if the corresponding  **Signature:** `ChoiceField(choices)`  - `choices` - A list of valid values, or a list of `(key, display_name)` tuples. +- `allow_blank` - If set to `True` then the empty string should be considered a valid value. If set to `False` then the empty string is considered invalid and will raise a validation error. Defaults to `False`. + +Both the `allow_blank` and `allow_null` are valid options on `ChoiceField`, although it is highly recommended that you only use one and not both. `allow_blank` should be preferred for textual choices, and `allow_null` should be preferred for numeric or other non-textual choices.  ## MultipleChoiceField @@ -318,6 +321,9 @@ A field that can accept a set of zero, one or many values, chosen from a limited  **Signature:** `MultipleChoiceField(choices)`  - `choices` - A list of valid values, or a list of `(key, display_name)` tuples. +- `allow_blank` - If set to `True` then the empty string should be considered a valid value. If set to `False` then the empty string is considered invalid and will raise a validation error. Defaults to `False`. + +As with `ChoiceField`, both the `allow_blank` and `allow_null` options are valid, although it is highly recommended that you only use one and not both. `allow_blank` should be preferred for textual choices, and `allow_null` should be preferred for numeric or other non-textual choices.  --- | 
