Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Backport 8.x] Documentation fixes #1789

Merged
merged 1 commit into from
Apr 29, 2024
Merged

[Backport 8.x] Documentation fixes #1789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,28 @@ The :ref:`Asynchronous API <async_api>` classes are documented separately.
.. py:module:: elasticsearch_dsl

.. autoclass:: Search
:inherited-members:
:members:

.. autoclass:: MultiSearch
:inherited-members:
:members:

.. autoclass:: Document
:inherited-members:
:members:

.. autoclass:: Index
:inherited-members:
:members:

.. autoclass:: FacetedSearch
:inherited-members:
:members:

.. autoclass:: UpdateByQuery
:members:
:inherited-members:
:members:

Mappings
--------
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ to the ``Elasticsearch`` class from ``elasticsearch-py``.

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

Multiple clusters
-----------------
Expand Down
4 changes: 2 additions & 2 deletions elasticsearch_dsl/_async/document.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ async def update(
:arg return_doc_meta: set to ``True`` to return all metadata from the
index API call instead of only the operation result

:return operation result noop/updated
:return: operation result noop/updated
"""
body = {
"doc_as_upsert": doc_as_upsert,
Expand Down Expand Up @@ -346,7 +346,7 @@ async def save(
Any additional keyword arguments will be passed to
``Elasticsearch.index`` unchanged.

:return operation result created/updated
:return: operation result created/updated
"""
if validate:
self.full_clean()
Expand Down
4 changes: 2 additions & 2 deletions elasticsearch_dsl/_sync/document.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ def update(
:arg return_doc_meta: set to ``True`` to return all metadata from the
index API call instead of only the operation result

:return operation result noop/updated
:return: operation result noop/updated
"""
body = {
"doc_as_upsert": doc_as_upsert,
Expand Down Expand Up @@ -344,7 +344,7 @@ def save(
Any additional keyword arguments will be passed to
``Elasticsearch.index`` unchanged.

:return operation result created/updated
:return: operation result created/updated
"""
if validate:
self.full_clean()
Expand Down
2 changes: 1 addition & 1 deletion elasticsearch_dsl/search_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ def params(self, **kwargs):
"""
Specify query params to be used when executing the search. All the
keyword arguments will override the current values. See
https://elasticsearch-py.readthedocs.io/en/master/api.html#elasticsearch.Elasticsearch.search
https://elasticsearch-py.readthedocs.io/en/latest/api/elasticsearch.html#elasticsearch.Elasticsearch.search
for all available parameters.

Example::
Expand Down
Loading