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.

Sign up for GitHub

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

Jump to bottom

fix: generate docs for search_engine.py #3507

Merged
merged 1 commit into from
Oct 31, 2022
Merged

fix: generate docs for search_engine.py #3507

merged 1 commit into from
Oct 31, 2022

Conversation

ZanSara
Copy link
Contributor

@ZanSara ZanSara commented Oct 31, 2022

Related Issues

n/a

Proposed Changes:

  • Add docs for search_engine.py This class documents many methods used by Elasticsearch and similar docstores.

How did you test it?

n/a

Notes for the reviewer

  • This is a patch on the fact that such method are not present in the document store classes themselves anymore.
  • This is not a complete fix as they are still not very visible as ES methods. Better suggestions welcome.

Checklist

@ZanSara ZanSara marked this pull request as ready for review October 31, 2022 11:37
@ZanSara ZanSara requested a review from a team as a code owner October 31, 2022 11:37
@ZanSara ZanSara requested review from masci and removed request for a team October 31, 2022 11:37
@ZanSara ZanSara changed the title fix: generate docs for search.engine.py fix: generate docs for search_engine.py Oct 31, 2022
@ZanSara ZanSara added type:bug Something isn't working topic:elasticsearch type:documentation Improvements on the docs topic:document_store journey:first steps ignore-for-release-notes PRs with this flag won't be included in the release notes. labels Oct 31, 2022
masci
masci approved these changes Oct 31, 2022
View reviewed changes
Copy link
Contributor

@masci masci left a comment

Choose a reason for hiding this comment

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

Thanks for fixing it 👍

@ZanSara ZanSara merged commit 8ddeda8 into main Oct 31, 2022
@ZanSara ZanSara deleted the doc_search_engine branch October 31, 2022 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@masci masci masci approved these changes

Assignees
No one assigned
Labels
ignore-for-release-notes PRs with this flag won't be included in the release notes. topic:document_store topic:elasticsearch type:bug Something isn't working type:documentation Improvements on the docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ZanSara @masci