Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC Ensures that get_data_home passes numpydoc validation #22259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Jan 24, 2022
Merged

DOC Ensures that get_data_home passes numpydoc validation #22259

merged 6 commits into from
Jan 24, 2022

Conversation

purna135
Copy link
Contributor

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

  • RT01: No Returns section found

Any other comments?

Thanks

@purna135 purna135 changed the title DOC Ensures that sklearn.datasets._base.get_data_home passes numpydoc validation DOC Ensures that get_data_home passes numpydoc validation Jan 21, 2022
jmloyola
jmloyola reviewed Jan 21, 2022
View reviewed changes
Copy link
Member

@jmloyola jmloyola left a comment

Choose a reason for hiding this comment

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

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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The path of the scikit-learn data dir.
Path of the scikit-learn data directory.

Copy link
Member

@jjerphan jjerphan Jan 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Based on the other docstrings, I guess we can unintended the text a bit and keep it verbose, like what @jmloyola proposes.

Suggested change
The path of the scikit-learn data dir.
The path of the scikit-learn data directory.

jjerphan
jjerphan approved these changes Jan 21, 2022
View reviewed changes
Copy link
Member

@jjerphan jjerphan left a comment

Choose a reason for hiding this comment

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

LGTM after addressing the main thread.

sklearn/datasets/_base.py Outdated
Returns
-------
data_home: str
The path of the scikit-learn data dir.
Copy link
Member

@jjerphan jjerphan Jan 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Based on the other docstrings, I guess we can unintended the text a bit and keep it verbose, like what @jmloyola proposes.

Suggested change
The path of the scikit-learn data dir.
The path of the scikit-learn data directory.

@purna135
Copy link
Contributor Author

I am confused about whether to do these changes or not.
finally, I am making a PR with these changes

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.

@purna135 purna135 requested review from jjerphan and jmloyola January 24, 2022 09:09
@jmloyola
Copy link
Member

LGTM

jjerphan
jjerphan approved these changes Jan 24, 2022
View reviewed changes
Copy link
Member

@jjerphan jjerphan left a comment

Choose a reason for hiding this comment

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

LGTM. just one comment for consistency.

@purna135
Copy link
Contributor Author

Thank you so much @jjerphan

thomasjpfan
thomasjpfan approved these changes Jan 24, 2022
View reviewed changes
Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

LGTM

@purna135
Copy link
Contributor Author

Thanks @thomasjpfan

@thomasjpfan thomasjpfan merged commit 449d916 into scikit-learn:main Jan 24, 2022
@thomasjpfan thomasjpfan mentioned this pull request Jan 29, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thomasjpfan thomasjpfan thomasjpfan approved these changes

@jjerphan jjerphan jjerphan approved these changes

@jmloyola jmloyola Awaiting requested review from jmloyola

Assignees
No one assigned
Labels
Documentation module:datasets No Changelog Needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@purna135 @jmloyola @thomasjpfan @jjerphan