Skip to content

Commit 8bb517d

Browse files
authored
Clarify complex filters param usage, pre-release compat (#285)
Clarify complex filters parameter usage, pre-release compat
2 parents f3e092c + 44e5596 commit 8bb517d

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ Using ``django-rest-framework-filters``, we can easily do stuff like::
3232

3333
----
3434

35+
**!** The 1.0 pre-release is compatible with django-filter 2.x and can be installed with
36+
``pip install --pre``.
37+
38+
----
39+
3540
.. contents::
3641
**Table of Contents**
3742
:local:
@@ -534,7 +539,10 @@ Below is the procedure for encoding a complex query:
534539
* URL-encode the individual querystrings.
535540
* Wrap the encoded strings in parentheses, and join with operators.
536541
* URL-encode the entire querystring.
537-
* Set as the value to the complex filter param (default: ``filters``).
542+
* Set as the value to the complex filter param (e.g., ``?filters=<complex querystring>``).
543+
544+
Note that ``filters`` is the default parameter name and can be overridden in the backend class.
545+
538546
539547
Using the first example, these steps can be visualized as so:
540548

0 commit comments

Comments
 (0)