Skip to content

DOC: clarify numpy.asarray, numpy.asanyarray, numpy.asarray_chkfinite parameter 'order' #29655

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.

Sign up for GitHub

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

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
+24 −18
Open

DOC: clarify numpy.asarray, numpy.asanyarray, numpy.asarray_chkfinite parameter 'order' #29655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2ce5230
DOC: clarified numpy.asarray parameter 'order'
nbidler Aug 15, 2025
fb68198
DOC: clarified numpy.asarray parameter 'order'
nbidler Aug 15, 2025
a10b7ee
Merge branch 'main' of https://github.com/nbidler/numpy
nbidler Aug 20, 2025
0bf4fc3
DOC: clarified numpy.asarray() parameter 'order'
nbidler Aug 21, 2025
ea30e66
Merge branch 'numpy:main' into main
nbidler Aug 21, 2025
68a8900
DOC: clarify numpy.asarray parameter 'order'
nbidler Aug 21, 2025
46d11bc
Merge branch 'main' of https://github.com/nbidler/numpy
nbidler Aug 21, 2025
26421d1
DOC numpy.asarray parameter 'order' description added line break
nbidler Aug 25, 2025
0acbb76
DOC: Additional request to change identical text blocks.
nbidler Aug 26, 2025
8de8888
DOC: fixed linebreak position
nbidler Aug 27, 2025
be180e7
Merge branch 'numpy:main' into main
nbidler Sep 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions numpy/_core/_add_newdocs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -967,12 +967,13 @@
dtype : data-type, optional
By default, the data-type is inferred from the input data.
order : {'C', 'F', 'A', 'K'}, optional
Memory layout. 'A' and 'K' depend on the order of input array a.
'C' row-major (C-style),
'F' column-major (Fortran-style) memory representation.
'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.
'C' gives a row-major layout (C-style),
'F' gives a column-major layout (Fortran-style).
'C' and 'F' will copy if needed to ensure the output format.
'A' (any) is equivalent to 'F' if input a is non-contiguous or Fortran-contiguous, otherwise, it is equivalent to 'C'.
Unlike 'C' or 'F', 'A' does not ensure that the result is contiguous.
'K' (keep) is the default and preserves the input order for the output.
device : str, optional
The device on which to place the created array. Default: ``None``.
For Array-API interoperability only, so must be ``"cpu"`` if passed.
Expand Down Expand Up @@ -1059,12 +1060,14 @@
dtype : data-type, optional
By default, the data-type is inferred from the input data.
order : {'C', 'F', 'A', 'K'}, optional
Memory layout. 'A' and 'K' depend on the order of input array a.
'C' row-major (C-style),
'F' column-major (Fortran-style) memory representation.
'A' (any) means 'F' if `a` is Fortran contiguous, 'C' otherwise
'K' (keep) preserve input order
Defaults to 'C'.
The memory layout of the output.
'C' gives a row-major layout (C-style),
'F' gives a column-major layout (Fortran-style).
'C' and 'F' will copy if needed to ensure the output format.
'A' (any) is equivalent to 'F' if input a is non-contiguous or Fortran-contiguous, otherwise, it is equivalent to 'C'.
Unlike 'C' or 'F', 'A' does not ensure that the result is contiguous.
'K' (keep) preserves the input order for the output.
'C' is the default.
device : str, optional
The device on which to place the created array. Default: ``None``.
For Array-API interoperability only, so must be ``"cpu"`` if passed.
Expand Down
15 changes: 9 additions & 6 deletions numpy/lib/_function_base_impl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -613,12 +613,15 @@ def asarray_chkfinite(a, dtype=None, order=None):
dtype : data-type, optional
By default, the data-type is inferred from the input data.
order : {'C', 'F', 'A', 'K'}, optional
Memory layout. 'A' and 'K' depend on the order of input array a.
'C' row-major (C-style),
'F' column-major (Fortran-style) memory representation.
'A' (any) means 'F' if `a` is Fortran contiguous, 'C' otherwise
'K' (keep) preserve input order
Defaults to 'C'.
The memory layout of the output.
'C' gives a row-major layout (C-style),
'F' gives a column-major layout (Fortran-style).
'C' and 'F' will copy if needed to ensure the output format.
'A' (any) is equivalent to 'F' if input a is non-contiguous or
Fortran-contiguous, otherwise, it is equivalent to 'C'.
Unlike 'C' or 'F', 'A' does not ensure that the result is contiguous.
'K' (keep) preserves the input order for the output.
'C' is the default.

Returns
-------
Expand Down