Skip to content

DOC ensures sklearn.utils.shuffle passes numpydoc validation#24367

Merged
glemaitre merged 4 commits intoscikit-learn:mainfrom
zadilkhwaja:shuffleNew
Sep 7, 2022
Merged

DOC ensures sklearn.utils.shuffle passes numpydoc validation#24367
glemaitre merged 4 commits intoscikit-learn:mainfrom
zadilkhwaja:shuffleNew

Conversation

@zadilkhwaja
Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Towards #21350 .

What does this implement/fix? Explain your changes.

DOC ensures sklearn.utils.shuffle passes numpydoc validation

@glemaitre
Copy link
Copy Markdown
Member

You should as well run black on the file since the linter complains.

@ogrisel
Copy link
Copy Markdown
Member

ogrisel commented Sep 6, 2022

black complains about the invisible trailing spaces. To fix this:

pip install black==22.3.0
black sklearn/utils/__init__.py

The black version number comes from https://scikit-learn.org/dev/developers/contributing.html#how-to-contribute

@zadilkhwaja
Copy link
Copy Markdown
Contributor Author

@ogrisel Hi, can you guide me on how to resolve these new errors

@glemaitre glemaitre self-requested a review September 7, 2022 10:14
Copy link
Copy Markdown
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

We need to add a description to be compliant with the numpydoc validation. I made a suggestion that you can accept and it should solve the CIs issue.

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@glemaitre glemaitre merged commit 49279c3 into scikit-learn:main Sep 7, 2022
@glemaitre
Copy link
Copy Markdown
Member

Thanks @zadilkhwaja

@zadilkhwaja
Copy link
Copy Markdown
Contributor Author

Thanks @zadilkhwaja

Thankyou for the help. I was able to understand a lot of new things.

@zadilkhwaja zadilkhwaja deleted the shuffleNew branch September 7, 2022 11:40
@glemaitre
Copy link
Copy Markdown
Member

Nice @zadilkhwaja Hope that you can continue contributing. I will be happy to review your subsequent PR ;)

glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Sep 12, 2022
…learn#24367)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
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