Skip to content

Bug in documentation #2385

Open
Open
@ruben1679

Description

@ruben1679

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions