DOC Ensure that ledoit_wolf is passing numpydoc validation#22496
Merged
jeremiedbb merged 4 commits intoscikit-learn:mainfrom Mar 21, 2022
Merged
DOC Ensure that ledoit_wolf is passing numpydoc validation#22496jeremiedbb merged 4 commits intoscikit-learn:mainfrom
jeremiedbb merged 4 commits intoscikit-learn:mainfrom
Conversation
thomasjpfan
reviewed
Feb 15, 2022
Member
thomasjpfan
left a comment
There was a problem hiding this comment.
Thank you for the PR. Please follow step 9 from the #21350 (comment)
Include the function name in the title of the pull request. For example: "DOC Ensures that ledoit_wolf passes numpydoc validation".
sklearn/tests/test_docstrings.py
Outdated
| FUNCTION_DOCSTRING_IGNORE_LIST = [ | ||
| "sklearn.covariance._shrunk_covariance.ledoit_wolf", | ||
| "sklearn.covariance._shrunk_covariance.ledoit_wolf_shrinkage", | ||
| "sklearn.datasets._base.load_linnerud", |
Member
There was a problem hiding this comment.
This PR should focus on ledoit_wolf. This means we do not need to remove load_linnerud from this list.
Member
There was a problem hiding this comment.
This is indeed the reason it fails.
glemaitre
pushed a commit
to glemaitre/scikit-learn
that referenced
this pull request
Apr 6, 2022
…arn#22496) Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
Addresses #21350
What does this implement/fix? Explain your changes.
I fixed the documentation for sklearn.covariance._shrunk_covariance.ledoit_wolf
Any other comments?