DOC: clarify numpy.asarray parameter 'order' meanings #29571
Closed
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
seberg
reviewed
Aug 19, 2025
numpy/_core/_add_newdocs.py
Outdated
| 'C' gives a row-major layout (C-style), | ||
| 'F' gives a column-major layout (Fortran-style). | ||
| Both 'C' and 'F' ensure a contiguous result. | ||
| 'A' (any) is equivalent to 'F' if input a is non-contiguous or Fortran-contiguous, otherwise, it is equivalent to 'C'. If the desired output is a non-contiguous Fortran-style ndarray, the user should set ``copy`` to ``True`` to ensure this. |
There was a problem hiding this comment.
Can we please just add a minimal thing that 'A', like 'K', will not copy to ensure a contiguous output?
Yeah, maybe still confusing, so mentioning the opposite that 'C' and 'F' will copy if needed is maybe clarifying.
jorenham
reviewed
Aug 19, 2025
numpy/_core/_add_newdocs.py
Outdated
| 'A' (any) means 'F' if `a` is Fortran contiguous, 'C' otherwise | ||
| 'K' (keep) preserve input order | ||
| Defaults to 'K'. | ||
| The memory layout of the output ndarray. The output of 'A' and 'K' depend on the memory layout of input a. |
There was a problem hiding this comment.
How about simplifying this to
Suggested change
| The memory layout of the output ndarray. The output of 'A' and 'K' depend on the memory layout of input a. | |
| The memory layout of the output. |
and move the explanation of the input-dependence of A and K to the individual explanations of A and K below?
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 #28247. Changed description of options for parameter
order- made explicit that 'C' and 'F' give contiguous results, and 'A' will give results equivalent to 'F' if the input is Fortran-contiguous OR non-contiguous, but if the desired output is non-contiguous Fortran-style then the user also needs to setcopytoTrue.