summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Schilling <schillingt@better-simple.com>2020-03-30 21:16:33 -0500
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2020-04-24 10:10:45 +0200
commita92cc84b4a206d18a5f1a0eaa47f19add40ff99b (patch)
tree6350267f49178ae1aef177c6194d6f55e90b005c /docs
parent34a69c24584ec7d842dbf266659b25527cd73909 (diff)
Refs #31369 -- Deprecated models.NullBooleanField in favor of BooleanField(null=True).
Diffstat (limited to 'docs')
-rw-r--r--docs/internals/deprecation.txt3
-rw-r--r--docs/ref/checks.txt2
-rw-r--r--docs/ref/models/fields.txt7
-rw-r--r--docs/releases/3.1.txt3
4 files changed, 13 insertions, 2 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt
index 76b379ef5a..8d3cc62d90 100644
--- a/docs/internals/deprecation.txt
+++ b/docs/internals/deprecation.txt
@@ -75,6 +75,9 @@ details on these changes.
* Support for passing raw column aliases to ``QuerySet.order_by()`` will be
removed.
+* The model ``NullBooleanField`` will be removed. A stub field will remain for
+ compatibility with historical migrations.
+
See the :ref:`Django 3.1 release notes <deprecated-features-3.1>` for more
details on these changes.
diff --git a/docs/ref/checks.txt b/docs/ref/checks.txt
index d9bfdb168c..d9b56c3c58 100644
--- a/docs/ref/checks.txt
+++ b/docs/ref/checks.txt
@@ -202,6 +202,8 @@ Model fields
in historical migrations.
* **fields.W902**: ``FloatRangeField`` is deprecated and will be removed in
Django 3.1. *This check appeared in Django 2.2 and 3.0*.
+* **fields.W903**: ``NullBooleanField`` is deprecated. Support for it (except
+ in historical migrations) will be removed in Django 4.0.
File fields
~~~~~~~~~~~
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index cbc3b6142c..19750eedc3 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -1182,8 +1182,11 @@ values are stored as null.
.. class:: NullBooleanField(**options)
-Like :class:`BooleanField` with ``null=True``. Use that instead of this field
-as it's likely to be deprecated in a future version of Django.
+Like :class:`BooleanField` with ``null=True``.
+
+.. deprecated:: 3.1
+
+ ``NullBooleanField`` is deprecated in favor of ``BooleanField(null=True)``.
``PositiveBigIntegerField``
---------------------------
diff --git a/docs/releases/3.1.txt b/docs/releases/3.1.txt
index 029ad3150c..fbefef589f 100644
--- a/docs/releases/3.1.txt
+++ b/docs/releases/3.1.txt
@@ -733,6 +733,9 @@ Miscellaneous
same result can be achieved by passing aliases in a
:class:`~django.db.models.expressions.RawSQL` instead beforehand.
+* The ``NullBooleanField`` model field is deprecated in favor of
+ ``BooleanField(null=True)``.
+
.. _removed-features-3.1:
Features removed in 3.1