Updated note on BooleanField required kwarg generation.

carltongibson · carltongibson · commit 31bf59708121 · 2019-03-01T12:48:12.000+01:00
Closes encode#6474.
diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md
@@ -124,7 +124,14 @@ 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.
 
-Note that default `BooleanField` instances will be generated with a `required=False` option (since Django `models.BooleanField` is always `blank=True`). If you want to change this behaviour explicitly declare the `BooleanField` on the serializer class.
+Note that Django 2.1 removed the `blank` kwarg from `models.BooleanField`.
+Prior to Django 2.1 `models.BooleanField` fields were always `blank=True`. Thus
+since Django 2.1 default `serializers.BooleanField` instances will be generated
+without the `required` kwarg (i.e. equivalent to `required=True`) whereas with
+previous versions of Django, default `BooleanField` instances will be generated
+with a `required=False` option.  If you want to control this behaviour manually,
+explicitly declare the `BooleanField` on the serializer class, or use the
+`extra_kwargs` option to set the `required` flag.
 
 Corresponds to `django.db.models.fields.BooleanField`.
 
