You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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.
The text was updated successfully, but these errors were encountered:
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 rendersfrom
: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:It's probably some issue when generating the docs from the docstrings.
What is the expected behavior?
Docs show
from_
instead offrom
.The text was updated successfully, but these errors were encountered: