aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTom Christie2014-12-17 15:13:48 +0000
committerTom Christie2014-12-17 15:13:48 +0000
commit3fff5cb6e0960b7ff8abd9f13a075f1f057de0a7 (patch)
tree8e3e795810ca0277539829849d70b85986bd93d6 /docs
parent426547c61c725ca7dc47671c084d1a2805c92305 (diff)
downloaddjango-rest-framework-3fff5cb6e0960b7ff8abd9f13a075f1f057de0a7.tar.bz2
Fix empty HTML values when a default is provided.
Diffstat (limited to 'docs')
-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()`