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

Fix wrong documentation for file serach.md regarding search_after param #584

Merged
merged 1 commit into from
Mar 4, 2024

Conversation

pajh0509
Copy link
Contributor

@pajh0509 pajh0509 commented Aug 11, 2023

Description

I was following instructions in search.md in order to use search() functions, especially with search_after param. And found out given example doesn't work. I made some changes so that people can make use of the code snippet in search.md without logical error.

Issues Resolved

No issue resolved

Check List

  • New functionality includes testing. -- no need to test
    • All tests pass
  • Linter check was successfull - yarn run lint doesn't show any errors
  • Commits are signed per the DCO using --signoff
  • Changelog was updated.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: pajh0509 <pajh0509@gmail.com>
@pajh0509 pajh0509 changed the title Fix wrong documentation for file serach.md regarding search_after param Fix wrong documentation for file serach.md regarding search_after param Aug 11, 2023
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. It would be great if this "pagination" example actually did pagination, meaning that it iterated through all pages and output all the results in a for loop.

aaaand, if you feel really inspired, we need working samples ala https://github.com/opensearch-project/opensearch-py/tree/main/samples here to avoid this kind of mistakes!

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

Successfully merging this pull request may close these issues.

3 participants