Skip to content

docs: clarify that behavior when provided a nested sequence to asarray is unspecified #917

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

Merged
merged 4 commits into from
May 26, 2025
Merged

docs: clarify that behavior when provided a nested sequence to asarray is unspecified #917

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c1cdabf
DOC: clarify that nested asarray is unspecified
ev-br Mar 28, 2025
b11fd84
Update src/array_api_stubs/_draft/creation_functions.py
lucascolley May 11, 2025
d23ec22
docs: move notes to notes section
kgryte May 26, 2025
3843466
docs: use consistent phrasing
kgryte May 26, 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
12 changes: 4 additions & 8 deletions src/array_api_stubs/_draft/creation_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,14 +100,6 @@ def asarray(

Default: ``None``.

.. admonition:: Note
:class: note

If ``dtype`` is not ``None``, then array conversions should obey :ref:`type-promotion` rules. Conversions not specified according to :ref:`type-promotion` rules may or may not be permitted by a conforming array library. To perform an explicit cast, use :func:`array_api.astype`.

.. note::
If an input value exceeds the precision of the resolved output array data type, behavior is left unspecified and, thus, implementation-defined.

device: Optional[device]
device on which to place the created array. If ``device`` is ``None`` and ``obj`` is an array, the output array device must be inferred from ``obj``. Default: ``None``.
copy: Optional[bool]
Expand All @@ -121,6 +113,10 @@ def asarray(
Notes
-----

- If ``obj`` is a sequence with some elements being arrays, behavior is unspecified and thus implementation-defined. Conforming implementations may perform a conversion or raise an exception. To join a sequence of arrays along a new axis, see :func:`~array_api.stack`.
- If ``dtype`` is not ``None``, then array conversions should obey :ref:`type-promotion` rules. Conversions not specified according to :ref:`type-promotion` rules may or may not be permitted by a conforming array library. To perform an explicit cast, use :func:`array_api.astype`.
- If an input value exceeds the precision of the resolved output array data type, behavior is left unspecified and, thus, implementation-defined.

.. versionchanged:: 2022.12
Added complex data type support.
"""
Expand Down