Skip to content

Commit fb9fae3

Browse files
miguelgrinberggithub-actions[bot]
authored andcommitted
Corrected documentation of sort option (#1773)
Fixes #1318 (cherry picked from commit 0c0bdb7)
1 parent 891c2fe commit fb9fae3

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/faceted_search.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,6 @@ declaring a ``FacetedSearch`` subclass:
3434
values should be instances of any ``Facet`` subclass, for example: ``{'tags':
3535
TermsFacet(field='tags')}``
3636

37-
``sort``
38-
tuple or list of fields on which the results should be sorted. The format of
39-
the individual fields are to be the same as those passed to
40-
:meth:`~elasticsearch_dsl.Search.sort`.
41-
4237

4338
Facets
4439
~~~~~~
@@ -95,7 +90,7 @@ Usage
9590
-----
9691

9792
The custom subclass can be instantiated empty to provide an empty search
98-
(matching everything) or with ``query`` and ``filters``.
93+
(matching everything) or with ``query``, ``filters`` and ``sort``.
9994

10095
``query``
10196
is used to pass in the text of the query to be performed. If ``None`` is
@@ -107,6 +102,12 @@ The custom subclass can be instantiated empty to provide an empty search
107102
the name of the facet (from ``.facets`` attribute) as the key and one of the
108103
possible values as value. For example ``{'tags': 'python'}``.
109104

105+
``sort``
106+
is a tuple or list of fields on which the results should be sorted. The format
107+
of the individual fields are to be the same as those passed to
108+
:meth:`~elasticsearch_dsl.Search.sort`.
109+
110+
110111
Response
111112
~~~~~~~~
112113

0 commit comments

Comments
 (0)