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

docs: Extend utils API docs coverage #3402

Merged
merged 3 commits into from
Oct 21, 2022
Merged

docs: Extend utils API docs coverage #3402

merged 3 commits into from
Oct 21, 2022

Conversation

brandenchan
Copy link
Contributor

Proposed Changes:

  • format function docstrings so that they get generated by pydoc markdown (specifically the doc_store util functions)
  • increase the number of util modules for which docstrings are being generated

How did you test it?

  • generated api docs locally

Checklist

@brandenchan brandenchan requested a review from a team as a code owner October 17, 2022 11:01
@brandenchan brandenchan requested review from masci, ZanSara, julian-risch and agnieszka-m and removed request for a team October 17, 2022 11:01
@masci masci added the type:documentation Improvements on the docs label Oct 19, 2022
@julian-risch julian-risch added type:documentation Improvements on the docs and removed type:documentation Improvements on the docs labels Oct 19, 2022
Copy link
Member

@julian-risch julian-risch left a comment

Choose a reason for hiding this comment

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

Looks quite good to me except for a tiny duplicate of early_stopping in the utils.yml. Further, I did not test it so I can't vouch that it works as expected.
I also saw that many different people were tagged as reviewers here. I guess that was by mistake because I don't think it's needed for this PR. 🙂

haystack/utils/doc_store.py Outdated Show resolved Hide resolved
haystack/utils/doc_store.py Outdated Show resolved Hide resolved
docs/_src/api/pydoc/utils.yml Outdated Show resolved Hide resolved
@brandenchan brandenchan requested review from julian-risch and removed request for masci, ZanSara and agnieszka-m October 19, 2022 15:24
Copy link
Member

@julian-risch julian-risch left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

@brandenchan brandenchan merged commit 03ba07d into main Oct 21, 2022
@brandenchan brandenchan deleted the utils_api_extension branch October 21, 2022 11:51
brandenchan added a commit that referenced this pull request Oct 31, 2022
* Add more utils modules

* Format docstrings

* Incorporate reviewer feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Improvements on the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants