From c41335fa27a23171ec8c319eaa0a713e575c1036 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Mon, 3 Mar 2014 19:20:48 +0800 Subject: [PATCH] Added backwards compatibliity checks to reference documentation. --- django/core/checks/compatibility/django_1_6_0.py | 2 +- docs/ref/checks.txt | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/django/core/checks/compatibility/django_1_6_0.py b/django/core/checks/compatibility/django_1_6_0.py index 436ff28f80..06fb113005 100644 --- a/django/core/checks/compatibility/django_1_6_0.py +++ b/django/core/checks/compatibility/django_1_6_0.py @@ -105,7 +105,7 @@ def _check_boolean_field_default_value(app_configs=None, **kwargs): return [ Warning( - "BooleanField does not have a default value. ", + "BooleanField does not have a default value.", hint=("Django 1.6 changed the default value of BooleanField from False to None. " "See https://docs.djangoproject.com/en/1.6/ref/models/fields/#booleanfield " "for more information."), diff --git a/docs/ref/checks.txt b/docs/ref/checks.txt index d560bc3999..908a32d4c8 100644 --- a/docs/ref/checks.txt +++ b/docs/ref/checks.txt @@ -19,6 +19,7 @@ Django's system checks are organized using the following tags: * ``models``: Checks governing model, field and manager definitions. * ``signals``: Checks on signal declarations and handler registrations. * ``admin``: Checks of any admin site declarations. +* ``compatibility``: Flagging potential problems with version upgrades. Some checks may be registered with multiple tags. @@ -99,6 +100,15 @@ Signals * **signals.E001**: was connected to the ```` signal with a lazy reference to the ```` sender, which has not been installed. +Backwards Compatibility +~~~~~~~~~~~~~~~~~~~~~~~ + +The following checks are performed to warn the user of any potential problems +that might occur as a result of a version upgrade. + +* **1_6.W001**: Some project unittests may not execute as expected. +* **1_6.W002**: BooleanField does not have a default value. + Admin -----