Skip to content

Commit 122c99a

Browse files
committed
Add a cross-reference to the indexing page in __getitem__ and __setitem__
1 parent 25e7177 commit 122c99a

File tree

4 files changed

+16
-0
lines changed

4 files changed

+16
-0
lines changed

src/array_api_stubs/_2021_12/array_object.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -465,6 +465,8 @@ def __getitem__(
465465
"""
466466
Returns ``self[key]``.
467467
468+
See :ref:`indexing` for details on supported indexing semantics.
469+
468470
Parameters
469471
----------
470472
self: array
@@ -914,6 +916,8 @@ def __setitem__(
914916
"""
915917
Sets ``self[key]`` to ``value``.
916918
919+
See :ref:`indexing` for details on supported indexing semantics.
920+
917921
Parameters
918922
----------
919923
self: array

src/array_api_stubs/_2022_12/array_object.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -489,6 +489,8 @@ def __getitem__(
489489
"""
490490
Returns ``self[key]``.
491491
492+
See :ref:`indexing` for details on supported indexing semantics.
493+
492494
Parameters
493495
----------
494496
self: array
@@ -937,6 +939,8 @@ def __setitem__(
937939
"""
938940
Sets ``self[key]`` to ``value``.
939941
942+
See :ref:`indexing` for details on supported indexing semantics.
943+
940944
Parameters
941945
----------
942946
self: array

src/array_api_stubs/_2023_12/array_object.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -616,6 +616,8 @@ def __getitem__(
616616
"""
617617
Returns ``self[key]``.
618618
619+
See :ref:`indexing` for details on supported indexing semantics.
620+
619621
Parameters
620622
----------
621623
self: array
@@ -1085,6 +1087,8 @@ def __setitem__(
10851087
"""
10861088
Sets ``self[key]`` to ``value``.
10871089
1090+
See :ref:`indexing` for details on supported indexing semantics.
1091+
10881092
Parameters
10891093
----------
10901094
self: array

src/array_api_stubs/_draft/array_object.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -616,6 +616,8 @@ def __getitem__(
616616
"""
617617
Returns ``self[key]``.
618618
619+
See :ref:`indexing` for details on supported indexing semantics.
620+
619621
Parameters
620622
----------
621623
self: array
@@ -1085,6 +1087,8 @@ def __setitem__(
10851087
"""
10861088
Sets ``self[key]`` to ``value``.
10871089
1090+
See :ref:`indexing` for details on supported indexing semantics.
1091+
10881092
Parameters
10891093
----------
10901094
self: array

0 commit comments

Comments
 (0)