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] Missing underscore in from_ documentation args #865

Open
josepdecid opened this issue Dec 2, 2024 · 1 comment
Open

[BUG] Missing underscore in from_ documentation args #865

josepdecid opened this issue Dec 2, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@josepdecid
Copy link

What is the bug?

The documentation for the from_ arg in OpenSearch Client doesn't show the underscore suffix for the following methods:

  • search
  • update_by_query
  • delete_by_query

Checking the args docstrings we can see that all from_ args have an underscore at the end (search, update_by_query, delete_by_query). However, the documentation renders from:

CleanShot 2024-12-02 at 20 56 09

This is very misleading as it's the only arg with an underscore at the end, but other args with underscore prefixes or between words seem to work as expected. If we try to use just from it raises an error:

OpenSearch.search() got an unexpected keyword argument 'from'

It's probably some issue when generating the docs from the docstrings.

What is the expected behavior?

Docs show from_ instead of from.

@josepdecid josepdecid added bug Something isn't working untriaged Need triage labels Dec 2, 2024
@dblock
Copy link
Member

dblock commented Dec 2, 2024

Care to check whether https://github.com/opensearch-project/opensearch-api-specification is correct and contribute a fix to the docs?

@dblock dblock removed the untriaged Need triage label Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants