Skip to content

Commit fe9b302

Browse files
committed
fix rendering issue, add one-line summary for new attribute
1 parent b07236b commit fe9b302

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/array_api_stubs/_draft/array_object.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,10 @@ def T(self: array) -> array:
119119
Limiting the transpose to two-dimensional arrays (matrices) deviates from the NumPy et al practice of reversing all axes for arrays having more than two-dimensions. This is intentional, as reversing all axes was found to be problematic (e.g., conflicting with the mathematical definition of a transpose which is limited to matrices; not operating on batches of matrices; et cetera). In order to reverse all axes, one is recommended to use the functional ``permute_dims`` interface found in this specification.
120120
"""
121121

122-
123122
@property
124123
def __dlpack_c_exchange_api__(self: array) -> PyCapsule:
125124
"""
125+
Object containing the DLPack C-API exchange API struct.
126126
127127
An optional static array type attribute stored in ``type(array_instance).__dlpack_c_exchange_api__``
128128
that can be used to retrieve the DLPack C-API exchange API struct in DLPack 1.3 or later to speed up
@@ -134,6 +134,7 @@ def __dlpack_c_exchange_api__(self: array) -> PyCapsule:
134134
out: PyCapsule
135135
The PyCapsule object containing the DLPack C-API exchange API struct.
136136
137+
137138
.. note::
138139
This is a static global object shared across all the array instances of the same type.
139140
It can be queried through the ``type(array_instance).__dlpack_c_exchange_api__`` attribute.

0 commit comments

Comments
 (0)