DOC Ensures that get_data_home passes numpydoc validation#22259
DOC Ensures that get_data_home passes numpydoc validation#22259thomasjpfan merged 6 commits intoscikit-learn:mainfrom
Conversation
jmloyola
left a comment
There was a problem hiding this comment.
Thanks for the PR @purnachandramansingh. This LGTM!
I left a suggestion about the return description.
Also, I think it would be nice if we replace "dir" with "directory" in the docstrings.
sklearn/datasets/_base.py
Outdated
| Returns | ||
| ------- | ||
| data_home: str | ||
| The path of the scikit-learn data dir. |
There was a problem hiding this comment.
| The path of the scikit-learn data dir. | |
| Path of the scikit-learn data directory. |
There was a problem hiding this comment.
Based on the other docstrings, I guess we can unintended the text a bit and keep it verbose, like what @jmloyola proposes.
| The path of the scikit-learn data dir. | |
| The path of the scikit-learn data directory. |
jjerphan
left a comment
There was a problem hiding this comment.
LGTM after addressing the main thread.
sklearn/datasets/_base.py
Outdated
| Returns | ||
| ------- | ||
| data_home: str | ||
| The path of the scikit-learn data dir. |
There was a problem hiding this comment.
Based on the other docstrings, I guess we can unintended the text a bit and keep it verbose, like what @jmloyola proposes.
| The path of the scikit-learn data dir. | |
| The path of the scikit-learn data directory. |
|
I am confused about whether to do these changes or not.
|
|
LGTM |
jjerphan
left a comment
There was a problem hiding this comment.
LGTM. just one comment for consistency.
Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>
|
Thank you so much @jjerphan |
|
Thanks @thomasjpfan |
Reference Issues/PRs
Addresses #21350
What does this implement/fix? Explain your changes.
This PR fixes the following error that was appearing for numpydoc validation for sklearn.datasets._base.get_data_home
Any other comments?
Thanks