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.

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

Bug in documentation #2385

Open
ruben1679 opened this issue Nov 24, 2023 · 0 comments
Open

Bug in documentation #2385

ruben1679 opened this issue Nov 24, 2023 · 0 comments

Comments

@ruben1679
Copy link

Describe the feature:

Elasticsearch version (bin/elasticsearch --version):

elasticsearch-py version (elasticsearch.__versionstr__): latest

Please make sure the major version matches the Elasticsearch server you are running.

Description of the problem including expected versus actual behavior:

Function documentation has a bug in the API reference:
https://elasticsearch-py.readthedocs.io/en/latest/api/elasticsearch.html

In function: https://elasticsearch-py.readthedocs.io/en/latest/api/elasticsearch.html#elasticsearch.Elasticsearch.search
the key from is invalid, please remove.

from – Starting document offset. Needs to be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

there is a from_ at the bottom, so this is just a stale parameter description.

Steps to reproduce:
check the documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants