aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Christie2014-08-07 09:11:17 +0100
committerTom Christie2014-08-07 09:11:17 +0100
commit31591d6cfca7d19a21c214b98e9256ed8b28182f (patch)
tree4bfae88c2f804536be0cf7c72d9aa1b761c47047
parent4086e0562c104b758313fa9b8ac22ede3642a579 (diff)
parent617745eca027dc17c37718a67f82700caef5be3a (diff)
downloaddjango-rest-framework-31591d6cfca7d19a21c214b98e9256ed8b28182f.tar.bz2
Merge pull request #1737 from kevinlondon/patch-2
Include query parameter override instructions for OrderingFilter
-rw-r--r--rest_framework/filters.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/rest_framework/filters.py b/rest_framework/filters.py
index 96d15eb9..c3b846ae 100644
--- a/rest_framework/filters.py
+++ b/rest_framework/filters.py
@@ -116,6 +116,10 @@ class OrderingFilter(BaseFilterBackend):
def get_ordering(self, request):
"""
Ordering is set by a comma delimited ?ordering=... query parameter.
+
+ The `ordering` query parameter can be overridden by setting
+ the `ordering_param` value on the OrderingFilter or by
+ specifying an `ORDERING_PARAM` value in the API settings.
"""
params = request.QUERY_PARAMS.get(self.ordering_param)
if params: