DOC: Add missing signature from nditer docstring#15877
Merged
eric-wieser merged 1 commit intonumpy:masterfrom Mar 31, 2020
Merged
DOC: Add missing signature from nditer docstring#15877eric-wieser merged 1 commit intonumpy:masterfrom
eric-wieser merged 1 commit intonumpy:masterfrom
Conversation
seberg
reviewed
Mar 31, 2020
|
|
||
| add_newdoc('numpy.core', 'nditer', | ||
| """ | ||
| nditer(op, flags=None, op_flags=None, op_dtypes=None, order='K', casting='safe', op_axes=None, itershape=(), buffersize=0) |
Member
There was a problem hiding this comment.
Suggested change
| nditer(op, flags=None, op_flags=None, op_dtypes=None, order='K', casting='safe', op_axes=None, itershape=(), buffersize=0) | |
| nditer(op, flags=None, op_flags=None, op_dtypes=None, order='K', casting='same_kind', op_axes=None, itershape=None, buffersize=0) |
Seems itershape None is also supported, so maybe nicer (OTOH its not documented below). I was wondering if we break the long line here, but seems we do not always, so fine to not do it.
So maybe we can just put it in as is, go ahead and merge yourself with or without the suggestion.
Member
Author
There was a problem hiding this comment.
I prefer showing (), since that also gives a clue about the type of the argument. Supporting None as an alias of an empty tuple seems weird to me, and I'm wondering how noisy it would be to deprecate it...
Member
Author
This was referenced Mar 31, 2020
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.