Skip to content

DOC numpy doc update for function check_memory#23039

Merged
jeremiedbb merged 2 commits intoscikit-learn:mainfrom
MarieSacksick:docstrings_check_memory
Apr 6, 2022
Merged

DOC numpy doc update for function check_memory#23039
jeremiedbb merged 2 commits intoscikit-learn:mainfrom
MarieSacksick:docstrings_check_memory

Conversation

@MarieSacksick
Copy link
Copy Markdown
Contributor

…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?

Comment on lines +345 to +346
If string or None, the location on which we want to create the joblib.Memory \
interface.
Copy link
Copy Markdown
Member

@ArturoAmorQ ArturoAmorQ Apr 4, 2022

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thank you for your suggestions! the PR is updated :)

@jeremiedbb jeremiedbb added No Changelog Needed Quick Review For PRs that are quick to review labels Apr 4, 2022
Copy link
Copy Markdown
Member

@jeremiedbb jeremiedbb left a comment

Choose a reason for hiding this comment

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

Thanks @MarieS-WiMLDS

@jeremiedbb jeremiedbb merged commit ddc8210 into scikit-learn:main Apr 6, 2022
jjerphan pushed a commit to jjerphan/scikit-learn that referenced this pull request Apr 29, 2022
@thomasjpfan thomasjpfan changed the title DOC numpy doc update for function sklearn.utils.validation.ch… DOC numpy doc update for function check_memory Jul 16, 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.

3 participants