Skip to content

DOC Ensure that tosequence passes numpydoc validation #22494

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 5 commits into from
Feb 17, 2022
Merged

DOC Ensure that tosequence passes numpydoc validation #22494

merged 5 commits into from
Feb 17, 2022

Conversation

Kaysera
Copy link
Contributor

@Kaysera Kaysera commented Feb 15, 2022

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

  1. Removed sklearn.utils.tosequence from FUNCTION_DOCSTRING_IGNORE_LIST
  2. Added description to x
  3. Added section Returns

Any other comments?

@Micky774
Copy link
Contributor

Hey there @Kaysera! Just wanted to mention that, as specified in #21350, you should:

Include the function name in the title of the pull request. For example: "DOC Ensures that config_context passes numpydoc validation".

So in this case, you should change your title to "DOC Ensure that tosequence passes numpydoc validation".

@Kaysera Kaysera changed the title Numpydoc validation DOC Ensure that tosequence passes numpydoc validation Feb 16, 2022
@Kaysera
Copy link
Contributor Author

Kaysera commented Feb 16, 2022

@Micky774 Thank you for your input. Changed!

glemaitre
glemaitre reviewed Feb 16, 2022
View reviewed changes
@Kaysera @glemaitre
Update sklearn/utils/__init__.py
a207853 
Added suggestion to convert some words to math notation

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@Kaysera
Copy link
Contributor Author

Kaysera commented Feb 17, 2022

@glemaitre Thanks for the suggestions. Changed!

@glemaitre glemaitre merged commit 8abc6d8 into scikit-learn:main Feb 17, 2022
@glemaitre
Copy link
Member

LGTM. Let's merge since the CIs are green.
Thanks @Kaysera

@ogrisel
Copy link
Member

ogrisel commented Feb 17, 2022 •
edited
Loading

If x is from any other type, x is returned casted as a list.

is not really correct. I would have written: "If x is from any other type, return a list containing a single element, namely the input x itself.

Edit: actually I am wrong. Please ignore.

@glemaitre
Copy link
Member

glemaitre commented Feb 17, 2022 •
edited
Loading

x is supposed to be an iterable, this makes the trick here.

Edit: actually I am wrong. Please ignore.

I could have been wrong as well. Better to have a second pair of eyes even with simple documentation changes.

@thomasjpfan thomasjpfan mentioned this pull request Feb 22, 2022
Closed
thomasjpfan pushed a commit to thomasjpfan/scikit-learn that referenced this pull request Mar 1, 2022
@Kaysera @glemaitre @thomasjpfan
DOC Ensure that tosequence passes numpydoc validation (scikit-learn#2…
e69a9c6 
…2494)

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
Reviewers

@glemaitre glemaitre glemaitre left review comments

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

Successfully merging this pull request may close these issues.
4 participants
@Kaysera @Micky774 @glemaitre @ogrisel