-
-
Notifications
You must be signed in to change notification settings - Fork 25.5k
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
Conversation
sklearn/utils/extmath.py
Outdated
@@ -668,6 +668,11 @@ def cartesian(arrays, out=None): | |||
2-D array of shape (M, len(arrays)) containing cartesian products |
There was a problem hiding this comment.
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
There was a problem hiding this 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.
Done it, All checks have passed 😄, what's next ? |
Just a quick fix for the |
…-learn#21513) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
…-learn#21513) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
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?