DOC Ensures that NMF passes numpydoc validation #20869
Merged
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
genvalen
commented
Aug 27, 2021
sklearn/decomposition/_nmf.py
Outdated
Comment on lines
1702
to
1708
| Returns | ||
| ------- | ||
| X : {ndarray, sparse matrix} of shape (n_samples, n_features) | ||
| Data matrix of original shape. | ||
| Returns a data matrix of the original shape. | ||
|
|
||
| .. versionadded:: 0.18 | ||
| .. versionadded:: 0.18 | ||
| """ |
There was a problem hiding this comment.
I got an RT03 error for this section (Return value has no description) even though it does have a description.
The test passes if I indent .. versionadded:: 0.18, making it part of the description.
I wanted to double check that this is okay since I haven't seen it before.
There was a problem hiding this comment.
I assume that inverse_transform was the method added in 0.18. A better way is to move this versionadded above the Parameters section.
There was a problem hiding this comment.
Thanks, that makes so much sense.
|
LGTM. Thanks @genvalen |
samronsin
pushed a commit
to samronsin/scikit-learn
that referenced
this pull request
Nov 30, 2021
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 #20308
What does this implement/fix? Explain your changes.
Any other comments?