entrouvert
/
debian-django-filter
17
0
Fork 0
Code Issues Pull Requests Releases Activity

Add settings deprecation docs

This commit is contained in:
Ryan P Kilby 2016-09-14 16:30:08 -04:00
parent 58114084c4
commit 8151cda319
2 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/migration.txt
View File

@ -153,3 +153,13 @@ on the FilterSet:
To fix this, simply remove the methods from your class. You can subclass
``OrderingFilter`` to migrate any custom logic.
Deprecated ``FILTERS_HELP_TEXT_FILTER`` and ``FILTERS_HELP_TEXT_EXCLUDE``
-------------------------------------------------------------------------
Details: https://github.com/carltongibson/django-filter/pull/437
Generated filter labels in 1.0 will be more descriptive, including humanized
text about the lookup being performed and if the filter is an exclusion filter.
These settings will no longer have an effect and will be removed in the 1.0 release.

4
docs/ref/settings.txt
View File

@ -16,9 +16,13 @@ Default: ``True``
Enable / disable the default field ``help_text`` on filters where ``exclude=True`` (:doc:`/ref/filters`). This does not affect fields which explicitly define ``help_text``.
.. note:: This setting is pending deprecation.
FILTERS_HELP_TEXT_FILTER
------------------------
Default: ``True``
Enable / disable the default field ``help_text`` on filters where ``exclude=False`` (:doc:`/ref/filters`). This does not affect fields which explicitly define ``help_text``.
.. note:: This setting is pending deprecation.