aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide
diff options
context:
space:
mode:
authorTom Christie2014-12-17 16:19:13 +0000
committerTom Christie2014-12-17 16:19:13 +0000
commit265ed9377e457ec6b757ff07e0720b0ebefbb89d (patch)
tree226aaac38a8651c4cf1710cd1dbb9b0e91697f57 /docs/api-guide
parentc9a2ce07037475359712104a8a68624e99bdfeb1 (diff)
parentad6533e554663a4c6c40fb02c7d7341fb5afe47f (diff)
downloaddjango-rest-framework-265ed9377e457ec6b757ff07e0720b0ebefbb89d.tar.bz2
Merge branch 'master' of https://github.com/tomchristie/django-rest-framework
Diffstat (limited to 'docs/api-guide')
-rw-r--r--docs/api-guide/fields.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md
index e4ef1d4a..f06db56c 100644
--- a/docs/api-guide/fields.md
+++ b/docs/api-guide/fields.md
@@ -112,6 +112,8 @@ Two options are currently used in HTML form generation, `'input_type'` and `'bas
A boolean representation.
+When using HTML encoded form input be aware that omitting a value will always be treated as setting a field to `False`, even if it has a `default=True` option specified. This is because HTML checkbox inputs represent the unchecked state by omitting the value, so REST framework treats omission as if it is an empty checkbox input.
+
Corresponds to `django.db.models.fields.BooleanField`.
**Signature:** `BooleanField()`