Skip to content

Commit 36d60a6

Browse files
Documentation fixes
1 parent a2945b2 commit 36d60a6

File tree

5 files changed

+13
-7
lines changed

5 files changed

+13
-7
lines changed

docs/api.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,28 @@ The :ref:`Asynchronous API <async_api>` classes are documented separately.
99
.. py:module:: elasticsearch_dsl
1010
1111
.. autoclass:: Search
12+
:inherited-members:
1213
:members:
1314

1415
.. autoclass:: MultiSearch
16+
:inherited-members:
1517
:members:
1618

1719
.. autoclass:: Document
20+
:inherited-members:
1821
:members:
1922

2023
.. autoclass:: Index
24+
:inherited-members:
2125
:members:
2226

2327
.. autoclass:: FacetedSearch
28+
:inherited-members:
2429
:members:
2530

2631
.. autoclass:: UpdateByQuery
27-
:members:
32+
:inherited-members:
33+
:members:
2834

2935
Mappings
3036
--------

docs/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ to the ``Elasticsearch`` class from ``elasticsearch-py``.
4545

4646
To see all
4747
possible configuration options refer to the `documentation
48-
<http://elasticsearch-py.readthedocs.io/en/master/api.html#elasticsearch>`_.
48+
<https://elasticsearch-py.readthedocs.io/en/latest/api/elasticsearch.html>`_.
4949

5050
Multiple clusters
5151
-----------------

elasticsearch_dsl/_async/document.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ async def update(
255255
:arg return_doc_meta: set to ``True`` to return all metadata from the
256256
index API call instead of only the operation result
257257
258-
:return operation result noop/updated
258+
:return: operation result noop/updated
259259
"""
260260
body = {
261261
"doc_as_upsert": doc_as_upsert,
@@ -346,7 +346,7 @@ async def save(
346346
Any additional keyword arguments will be passed to
347347
``Elasticsearch.index`` unchanged.
348348
349-
:return operation result created/updated
349+
:return: operation result created/updated
350350
"""
351351
if validate:
352352
self.full_clean()

elasticsearch_dsl/_sync/document.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ def update(
253253
:arg return_doc_meta: set to ``True`` to return all metadata from the
254254
index API call instead of only the operation result
255255
256-
:return operation result noop/updated
256+
:return: operation result noop/updated
257257
"""
258258
body = {
259259
"doc_as_upsert": doc_as_upsert,
@@ -344,7 +344,7 @@ def save(
344344
Any additional keyword arguments will be passed to
345345
``Elasticsearch.index`` unchanged.
346346
347-
:return operation result created/updated
347+
:return: operation result created/updated
348348
"""
349349
if validate:
350350
self.full_clean()

elasticsearch_dsl/search_base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ def params(self, **kwargs):
143143
"""
144144
Specify query params to be used when executing the search. All the
145145
keyword arguments will override the current values. See
146-
https://elasticsearch-py.readthedocs.io/en/master/api.html#elasticsearch.Elasticsearch.search
146+
https://elasticsearch-py.readthedocs.io/en/latest/api/elasticsearch.html#elasticsearch.Elasticsearch.search
147147
for all available parameters.
148148
149149
Example::

0 commit comments

Comments
 (0)