Skip to content
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.

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

DOC Ensures that extmath.cartesian passes numpydoc validation #21513

Merged
merged 5 commits into from
Nov 2, 2021
Merged

DOC Ensures that extmath.cartesian passes numpydoc validation #21513

merged 5 commits into from
Nov 2, 2021

Conversation

anonymousr007
Copy link
Contributor

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

This is my first PR in scikit-learn during #DataUmbrella sprint.

Any other comments?

@@ -668,6 +668,11 @@ def cartesian(arrays, out=None):
2-D array of shape (M, len(arrays)) containing cartesian products
Copy link
Member

Choose a reason for hiding this comment

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

Could you modify the signature of out with:

out : ndarray of shape (M, len(arrays))
        Array containing the cartesian products formed of input arrays.

Please edit as the out parameter of the Parameters section

Copy link
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

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

Besides the typo (please press the "commit suggestion" button if you agree), LGTM.

sklearn/utils/extmath.py Outdated Show resolved Hide resolved
@anonymousr007
Copy link
Contributor Author

Done it, All checks have passed 😄, what's next ?

@glemaitre glemaitre merged commit 8cfbc38 into scikit-learn:main Nov 2, 2021
@glemaitre
Copy link
Member

Just a quick fix for the out in the parameter list but otherwise LGTM. Merging.

@reshamas reshamas added the Sprint label Nov 5, 2021
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
…-learn#21513)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Dec 24, 2021
…-learn#21513)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre added a commit that referenced this pull request Dec 25, 2021
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.

4 participants