DOC numpy doc update for function check_memory #23039
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
ArturoAmorQ
reviewed
Apr 4, 2022
sklearn/utils/validation.py
Outdated
Comment on lines
345
to
346
| If string or None, the location on which we want to create the joblib.Memory \ | ||
| interface. |
There was a problem hiding this comment.
Suggested change
| If string or None, the location on which we want to create the joblib.Memory \ | |
| interface. | |
| If string, the location on which we want to create the `joblib.Memory` | |
| interface. If None is given, no caching is done and the Memory object | |
| is completely transparent. |
Otherwise LGTM
There was a problem hiding this comment.
I would even do
Suggested change
| If string or None, the location on which we want to create the joblib.Memory \ | |
| interface. | |
| - If string, the location where to create the `joblib.Memory` interface. | |
| - If None, no caching is done and the Memory object is completely transparent. |
There was a problem hiding this comment.
Thank you for your suggestions! the PR is updated :)
…arn/utils/validation
jjerphan
pushed a commit
to jjerphan/scikit-learn
that referenced
this pull request
Apr 29, 2022
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.
…eck_memory #21350
Reference Issues/PRs
Reference issue: 21350
What does this implement/fix? Explain your changes.
This fixes the numpydoc for the function check_memory in sklearn/utils/validation.py.
Any other comments?