Skip to content

Commit 1edb7b0

Browse files
authored
Merge pull request #47 from asmeurer/doc-fixes
Some small fixes to docs
2 parents eced421 + 43f5a6e commit 1edb7b0

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

array_api_strict/_flags.py

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ def set_array_api_strict_flags(
8181
array-api-strict will change the default version to 2023.12.
8282
8383
boolean_indexing : bool, optional
84-
Whether indexing by a boolean array is supported.
85-
Note that although boolean array indexing does result in
84+
Whether indexing by a boolean array is supported. This flag is enabled
85+
by default. Note that although boolean array indexing does result in
8686
data-dependent shapes, this flag is independent of the
8787
`data_dependent_shapes` flag (see below).
8888
@@ -276,6 +276,19 @@ class ArrayAPIStrictFlags:
276276
See :func:`set_array_api_strict_flags` for a
277277
description of the available flags.
278278
279+
Examples
280+
--------
281+
282+
>>> from array_api_strict import ArrayAPIStrictFlags, get_array_api_strict_flags
283+
>>> with ArrayAPIStrictFlags(api_version="2022.12", boolean_indexing=False):
284+
... flags = get_array_api_strict_flags()
285+
>>> flags
286+
{'api_version': '2022.12',
287+
'boolean_indexing': False,
288+
'data_dependent_shapes': True,
289+
'enabled_extensions': ('linalg', 'fft')
290+
}
291+
279292
See Also
280293
--------
281294

0 commit comments

Comments
 (0)