Skip to content

Commit 22352d2

Browse files
committed
Update some flags documentation
1 parent 30baeb7 commit 22352d2

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

array_api_strict/_flags.py

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
"""
2-
This file defines flags for that allow array-api-strict to be used in
3-
different "modes". These modes include
2+
These functions configure global flags that allow array-api-strict to be
3+
used in different "modes". These modes include
44
55
- Changing to different supported versions of the standard.
66
- Enabling or disabling different optional behaviors (such as data-dependent
77
shapes).
88
- Enabling or disabling different optional extensions.
99
10-
Nothing in this file is part of the standard itself. A typical array API
10+
None of these functions are part of the standard itself. A typical array API
1111
library will only support one particular configuration of these flags.
12+
1213
"""
1314

1415
import functools
@@ -112,8 +113,8 @@ def set_array_api_strict_flags(
112113
See Also
113114
--------
114115
115-
get_array_api_strict_flags
116-
reset_array_api_strict_flags
116+
get_array_api_strict_flags: Get the current values of flags.
117+
reset_array_api_strict_flags: Reset the flags to their default values.
117118
ArrayApiStrictFlags: A context manager to temporarily set the flags.
118119
119120
"""
@@ -175,8 +176,8 @@ def get_array_api_strict_flags():
175176
See Also
176177
--------
177178
178-
set_array_api_strict_flags
179-
reset_array_api_strict_flags
179+
set_array_api_strict_flags: Set one or more flags to a given value.
180+
reset_array_api_strict_flags: Reset the flags to their default values.
180181
ArrayApiStrictFlags: A context manager to temporarily set the flags.
181182
182183
"""
@@ -207,8 +208,8 @@ def reset_array_api_strict_flags():
207208
See Also
208209
--------
209210
210-
set_array_api_strict_flags
211-
get_array_api_strict_flags
211+
get_array_api_strict_flags: Get the current values of flags.
212+
set_array_api_strict_flags: Set one or more flags to a given value.
212213
ArrayApiStrictFlags: A context manager to temporarily set the flags.
213214
214215
"""
@@ -234,9 +235,9 @@ class ArrayApiStrictFlags:
234235
See Also
235236
--------
236237
237-
set_array_api_strict_flags
238-
get_array_api_strict_flags
239-
reset_array_api_strict_flags
238+
get_array_api_strict_flags: Get the current values of flags.
239+
set_array_api_strict_flags: Set one or more flags to a given value.
240+
reset_array_api_strict_flags: Reset the flags to their default values.
240241
241242
"""
242243
def __init__(self, *, api_version=None, data_dependent_shapes=None,

0 commit comments

Comments
 (0)