DOC Ensures that sklearn.base.clone passes numpydoc validation #21557
Conversation
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
adrinjalali
reviewed
Nov 6, 2021
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
|
Thanks for the feedback. I made changes, please review when you have chance @adrinjalali @ogrisel |
adrinjalali
approved these changes
Nov 16, 2021
jjerphan
approved these changes
Nov 22, 2021
glemaitre
pushed a commit
to glemaitre/scikit-learn
that referenced
this pull request
Nov 29, 2021
…t-learn#21557) * sklearn clone numpydoc validation fix * adjusting docstring and reverting earlier unrelated change * Update sklearn/base.py Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com> * Update sklearn/base.py Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com> Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
samronsin
pushed a commit
to samronsin/scikit-learn
that referenced
this pull request
Nov 30, 2021
…t-learn#21557) * sklearn clone numpydoc validation fix * adjusting docstring and reverting earlier unrelated change * Update sklearn/base.py Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com> * Update sklearn/base.py Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com> Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
glemaitre
pushed a commit
to glemaitre/scikit-learn
that referenced
this pull request
Dec 24, 2021
…t-learn#21557) * sklearn clone numpydoc validation fix * adjusting docstring and reverting earlier unrelated change * Update sklearn/base.py Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com> * Update sklearn/base.py Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com> Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
glemaitre
pushed a commit
that referenced
this pull request
Dec 25, 2021
* sklearn clone numpydoc validation fix * adjusting docstring and reverting earlier unrelated change * Update sklearn/base.py Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com> * Update sklearn/base.py Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com> Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR fixes the following errors that were appearing for numpydoc validation for Base.clone():
Any other comments?
One interesting note: If the summary/description includes the word "yield", it causes the validator to expect a
Yieldssection in addition to aReturnssection. However, including both also results in an error, and so it seems like it may be good practice to avoid using the keyword "yield" altogether inside of descriptions.