DOC add docstring example for clear_data_home and fetch_covtype #28027
Conversation
…it-learn into sd-doc-example-issue-27982
There was a problem hiding this comment.
Documenting the fetcher is a bit tricky: if we don't have access to internet then we don't want to run the test.
I modified the conftest to have the right behaviour. I also skip the testing of the clear_data_home because we don't want to run it (it will remove the cache when we test and I don't want to make a complex example with temporary directory).
|
Hi Thank you for your time! I am new and not sure what should I do now? Is this PR approved and will it be merged? Should I make some further changes? |
|
@Dutta-SD CI is green now and you've already got one approval. I think for now you just need to wait for one more approval from maintainers before the PR can be merged. |
|
Yep, everything is good here. We will enable auto-merge. Since it was tricky regarding the network skipping, we pushed into your PR. Usually, we instead request changes in which case, you need to address and push the changes into your remote branch. Thanks @Dutta-SD for contributing. |
|
Hey, thank you so much for guiding me! |
| @@ -85,6 +85,11 @@ def clear_data_home(data_home=None): | |||
| data_home : str or path-like, default=None | |||
| The path to scikit-learn data directory. If `None`, the default path | |||
| is `~/scikit_learn_data`. | |||
|
|
|||
| Examples | |||
| ---------- | |||
There was a problem hiding this comment.
Though the PR has already been merged I think it's worth mentioning that the underline length is wrong, causing numpydoc to raise warning during doc build.
There was a problem hiding this comment.
Good catch. I will make a quick PR. Thanks.
…it-learn#28027) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> Co-authored-by: Loïc Estève <loic.esteve@ymail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> Co-authored-by: Loïc Estève <loic.esteve@ymail.com>
…it-learn#28027) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> Co-authored-by: Loïc Estève <loic.esteve@ymail.com>
Reference Issues/PRs
#27982
What does this implement/fix? Explain your changes.
sklearn.datasets.clear_data_home()sklearn.datasets.fetch_covtype()Any other comments?