Skip to content

DOC Ensures ledoit_wolf_shrinkage passes numpydoc#22748

Merged
thomasjpfan merged 1 commit intoscikit-learn:mainfrom
AmarCodes-22:ledoit_wolf_shrinkage_ensure_numpydoc_validation
Mar 10, 2022
Merged

DOC Ensures ledoit_wolf_shrinkage passes numpydoc#22748
thomasjpfan merged 1 commit intoscikit-learn:mainfrom
AmarCodes-22:ledoit_wolf_shrinkage_ensure_numpydoc_validation

Conversation

@AmarCodes-22
Copy link
Copy Markdown
Contributor

Reference Issues/PRs

#21350

What does this implement/fix? Explain your changes.

This PR ensures that function sklearn.covariance._shrunk_covariance.ledoit_wolf_shrinkage passes numpydoc validation

  • Remove sklearn.covariance._shrunk_covariance.ledoit_wolf_shrinkage from FUNCTION_DOCSTRING_IGNORE_LIST in sklearn.tests.test_docstrings.py
  • Verify all tests are passing

Any other comments?

Copy link
Copy Markdown
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

Thank you for the PR @AmarCodes-22 ! LGTM

@thomasjpfan thomasjpfan changed the title DOC: Ensures that function passes numpydoc validation: ledoit_wolf_shrinkage DOC Ensures ledoit_wolf_shrinkage passes numpydoc Mar 10, 2022
@thomasjpfan thomasjpfan merged commit 05ef752 into scikit-learn:main Mar 10, 2022
@AmarCodes-22 AmarCodes-22 deleted the ledoit_wolf_shrinkage_ensure_numpydoc_validation branch March 11, 2022 16:10
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Apr 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants