elasticsearch-py icon indicating copy to clipboard operation
elasticsearch-py copied to clipboard

Bug in documentation

Open ruben1679 opened this issue 2 years ago • 0 comments

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

ruben1679 avatar Nov 24 '23 19:11 ruben1679