DOC: clarify numpy.asarray, numpy.asanyarray, numpy.asarray_chkfinite parameter 'order' #29655
+24
−18
Conversation
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
Changed description to make explicit that setting 'A' requires user to set 'copy' to 'True' to get the described behavior. Made explicit that 'A' has two cases where it acts as equivalent to setting 'F'. See 28247.
See 28247. Changed description of 'order' to make the behavior of 'A' more explicit and how to cause it to preserve non-contiguous Fortran-order. Changed description of 'C' and 'F' to clarify that output will be contiguous.
See 28247. To differentiate between 'A' and 'K', made explicit that 'A' will not ensure the output is contiguous. 'K' has more complex behavior related to flags and stride detection, but will try to keep the output as close as possible to the input.
See 28247. Made explicit that 'C' and 'F' can copy input to output, 'A' does not ensure contiguous output.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
See issue 28247. Made explicit that 'C' and 'F' can copy input to ensure output format, 'A' does not ensure contiguous output. Kept 'K' the same because all the stride analysis/flag-handling behavior should be extraneous to the end user. See PR 29606. Member melissawm approved initially, then Member @seberg requested "can you see which other places have the identical comment, we should change them all (where applicable" so additional changes were made to the 'order' parameter of
asanyarrayandasarray_chkfinitebecause their descriptions were identical toasarrayand behavior was very similar toasarray. This is a new PR that includes initial changes and the requested additions.