Skip to content

docs: move notes below the fold and highlight RFC 2119 keywords #956

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 1 commit into from
Jun 12, 2025
Merged

docs: move notes below the fold and highlight RFC 2119 keywords #956

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
76 changes: 33 additions & 43 deletions src/array_api_stubs/_draft/info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,17 @@ def __array_namespace_info__() -> Info:
"""
Returns a namespace with Array API namespace inspection utilities.
See :ref:`inspection` for a list of inspection APIs.
Returns
-------
out: Info
An object containing Array API namespace inspection utilities.
an object containing Array API namespace inspection utilities.
Notes
-----
The returned object may be either a namespace or a class, so long as an Array API user can access inspection utilities as follows:
- See :ref:`inspection` for a list of inspection APIs.
- The returned object **may** be either a namespace or a class, as long as an Array API user can access inspection utilities as follows:
::
Expand All @@ -54,16 +54,14 @@ def capabilities() -> Capabilities:
"""
Returns a dictionary of array library capabilities.
The dictionary must contain the following keys:
- `"boolean indexing"`: boolean indicating whether an array library supports boolean indexing. If a conforming implementation fully supports boolean indexing in compliance with this specification (see :ref:`indexing`), the corresponding dictionary value must be ``True``; otherwise, the value must be ``False``.
- `"data-dependent shapes"`: boolean indicating whether an array library supports data-dependent output shapes. If a conforming implementation fully supports all APIs included in this specification (excluding boolean indexing) which have data-dependent output shapes, as explicitly demarcated throughout the specification, the corresponding dictionary value must be ``True``; otherwise, the value must be ``False``.
- `"max dimensions"`: maximum number of supported dimensions. If a conforming implementation supports arrays having an arbitrary number of dimensions (potentially infinite), the corresponding dictionary value must be ``None``; otherwise, the value must be a finite integer.
Returns
-------
out: Capabilities
a dictionary of array library capabilities.
a dictionary of array library capabilities. The returned dictionary **must** contain the following keys:
- `"boolean indexing"`: boolean indicating whether an array library supports boolean indexing. If a conforming implementation fully supports boolean indexing in compliance with this specification (see :ref:`indexing`), the corresponding dictionary value **must** be ``True``; otherwise, the value **must** be ``False``.
- `"data-dependent shapes"`: boolean indicating whether an array library supports data-dependent output shapes. If a conforming implementation fully supports all APIs included in this specification (excluding boolean indexing) which have data-dependent output shapes, as explicitly demarcated throughout the specification, the corresponding dictionary value **must** be ``True``; otherwise, the value **must** be ``False``.
- `"max dimensions"`: maximum number of supported dimensions. If a conforming implementation supports arrays having an arbitrary number of dimensions (potentially infinite), the corresponding dictionary value **must** be ``None``; otherwise, the value **must** be a finite integer.
Notes
-----
Expand Down Expand Up @@ -98,31 +96,28 @@ def default_dtypes(
"""
Returns a dictionary containing default data types.
The dictionary must have the following keys:
- `"real floating"`: default real floating-point data type.
- `"complex floating"`: default complex floating-point data type.
- `"integral"`: default integral data type.
- `"indexing"`: default array index data type.
Dictionary values must be the corresponding data type object.
Parameters
----------
device: Optional[device]
device for which to return default data types. If ``device`` is ``None``, the returned data types must be the default data types for the current device; otherwise, the returned data types must be default data types specific to the specified device. Default: ``None``.
.. note::
Some array libraries have the concept of a device context manager, allowing library consumers to manage the current device context. When ``device`` is ``None``, libraries supporting a device context should return the default data types for the current device. For libraries without a context manager or supporting only a single device, those libraries should return the default data types for the default device.
device for which to return default data types. If ``device`` is ``None``, the returned data types **must** be the default data types for the current device; otherwise, the returned data types **must** be default data types specific to the specified device. Default: ``None``.
Returns
-------
out: DefaultDataTypes
a dictionary containing the default data type for respective data type kinds.
a dictionary containing the default data type for respective data type kinds. The returned dictionary **must** have the following keys:
- `"real floating"`: default real floating-point data type.
- `"complex floating"`: default complex floating-point data type.
- `"integral"`: default integral data type.
- `"indexing"`: default array index data type.
Dictionary values **must** be the corresponding data type object.
Notes
-----
- Some array libraries have the concept of a device context manager, allowing library consumers to manage the current device context. When ``device`` is ``None``, libraries supporting a device context **must** return the default data types for the current device. For libraries without a context manager or supporting only a single device, those libraries **must** return the default data types for the default device.
.. versionadded: 2023.12
"""

Expand All @@ -135,20 +130,14 @@ def dtypes(
"""
Returns a dictionary of supported *Array API* data types.
.. note::
While specification-conforming array libraries may support additional data types which are not present in this specification, data types which are not present in this specification should not be included in the returned dictionary.
.. note::
Specification-conforming array libraries must only return supported data types having expected properties as described in :ref:`data-types`. For example, if a library decides to alias ``float32`` as ``float64``, that library must not include ``float64`` in the dictionary of supported data types.
Parameters
----------
kind: Optional[Union[str, Tuple[str, ...]]]
data type kind.
- If ``kind`` is ``None``, the function must return a dictionary containing all supported Array API data types.
- If ``kind`` is ``None``, the function **must** return a dictionary containing all supported Array API data types.
- If ``kind`` is a string, the function must return a dictionary containing the data types belonging to the specified data type kind. The following data type kinds must be supported:
- If ``kind`` is a string, the function **must** return a dictionary containing the data types belonging to the specified data type kind. The following data type kinds **must** be supported:
- ``'bool'``: boolean data types (e.g., ``bool``).
- ``'signed integer'``: signed integer data types (e.g., ``int8``, ``int16``, ``int32``, ``int64``).
Expand All @@ -158,26 +147,27 @@ def dtypes(
- ``'complex floating'``: complex floating-point data types (e.g., ``complex64``, ``complex128``).
- ``'numeric'``: numeric data types. Shorthand for ``('integral', 'real floating', 'complex floating')``.
- If ``kind`` is a tuple, the tuple specifies a union of data type kinds, and the function must return a dictionary containing the data types belonging to at least one of the specified data type kinds.
- If ``kind`` is a tuple, the tuple specifies a union of data type kinds, and the function **must** return a dictionary containing the data types belonging to at least one of the specified data type kinds.
Default: ``None``.
device: Optional[device]
device for which to return supported data types. If ``device`` is ``None``, the returned data types must be the supported data types for the current device; otherwise, the returned data types must be supported data types specific to the specified device. Default: ``None``.
.. note::
Some array libraries have the concept of a device context manager, allowing library consumers to manage the current device context. When ``device`` is ``None``, libraries supporting a device context should return the supported data types for the current device. For libraries without a context manager or supporting only a single device, those libraries should return the supported data types for the default device.
device: Optional[device]
device for which to return supported data types. If ``device`` is ``None``, the returned data types **must** be the supported data types for the current device; otherwise, the returned data types **must** be supported data types specific to the specified device. Default: ``None``.
Returns
-------
out: DataTypes
a dictionary containing supported data types.
.. note::
Dictionary keys must only consist of canonical names as defined in :ref:`data-types`.
a dictionary containing supported data types. The returned dictionary **must** only contain keys corresponding to the canonical names as defined in :ref:`data-types`.
Notes
-----
- While specification-conforming array libraries **may** support additional data types which are not present in this specification, data types which are not present in this specification **must not** be included in the returned dictionary.
- Specification-conforming array libraries **must** only return supported data types having expected properties as described in :ref:`data-types`. For example, if a library decides to alias ``float32`` as ``float64``, that library **must not** include ``float64`` in the dictionary of supported data types.
- Some array libraries have the concept of a device context manager, allowing library consumers to manage the current device context. When ``device`` is ``None``, libraries supporting a device context **must** return the supported data types for the current device. For libraries without a context manager or supporting only a single device, those libraries **must** return the supported data types for the default device.
.. versionadded: 2023.12
"""

Expand All @@ -194,7 +184,7 @@ def devices() -> List[device]:
Notes
-----
Each device object (see :ref:`device-support`) in the list of returned devices must be an object which can be provided as a valid keyword-argument to array creation functions.
- Each device object (see :ref:`device-support`) in the list of returned devices **must** be an object which can be provided as a valid keyword-argument to array creation functions.
Notes
-----
Expand Down