@@ -6,22 +6,22 @@ be a small library that packages can either vendor or add as a dependency to
66implement array API support. Consequently, certain design considerations
77should be taken into account:
88
9- - * No Hard Dependencies.* Although array-api-compat "depends" on NumPy, CuPy,
9+ - ** No Hard Dependencies.* * Although array-api-compat "depends" on NumPy, CuPy,
1010 PyTorch, etc., it does not hard depend on them. These libraries are not
1111 imported unless either an array object is passed to
1212 {func}` ~.array_namespace() ` , or the specific ` array_api_compat.<namespace> `
1313 sub-namespace is explicitly imported.
1414
15- - * Vendorability.* array-api-compat should be [ vendorable] ( vendoring ) . This
15+ - ** Vendorability.* * array-api-compat should be [ vendorable] ( vendoring ) . This
1616 means that, for instance, all imports in the library are relative imports.
1717 No code in the package specifically references the name ` array_api_compat `
1818 (we also support renaming the package to something else).
1919 Vendorability support is tested in ` tests/test_vendoring.py ` .
2020
21- - * Pure Python.* To make array-api-compat as easy as possible to add as a
21+ - ** Pure Python.* * To make array-api-compat as easy as possible to add as a
2222 dependency, the code is all pure Python.
2323
24- - * Minimal Wrapping Only.* The wrapping functionality is minimal. This means
24+ - ** Minimal Wrapping Only.* * The wrapping functionality is minimal. This means
2525 that if something is difficult to wrap using pure Python, or if trying to
2626 support some array API behavior would require a significant amount of code,
2727 we prefer to leave the behavior as an upstream issue for the array library,
@@ -34,15 +34,15 @@ should be taken into account:
3434 API standard is currently out-of-scope for this package (see the
3535 [ Scope] ( scope ) section of the documentation).
3636
37- - * No Side-Effects* . array-api-compat behavior should be localized to only the
37+ - ** No Side-Effects* * . array-api-compat behavior should be localized to only the
3838 specific code that imports and uses it. It should be invisible to end-users
3939 or users of dependent codes. This in particular implies to the next two
4040 points.
4141
42- - * No Monkey Patching.* ` array-api-compat ` should not attempt to modify
42+ - ** No Monkey Patching.* * ` array-api-compat ` should not attempt to modify
4343 anything about the underlying library. It is a * wrapper* library only.
4444
45- - * No Modifying the Array Object.* The array (or tensor) object of the array
45+ - ** No Modifying the Array Object.* * The array (or tensor) object of the array
4646 library cannot be modified. This also precludes the creation of array
4747 subclasses or wrapper classes.
4848
@@ -57,7 +57,7 @@ should be taken into account:
5757 and by using the [ helper functions] ( ../helper-functions.rst ) provided by
5858 array-api-compat instead of attributes or methods like ` x.to_device() ` .
5959
60- - * Avoid Restricting Behavior that is Outside the Scope of the Standard.* All
60+ - ** Avoid Restricting Behavior that is Outside the Scope of the Standard.* * All
6161 array libraries have functions and behaviors that are outside of the scope
6262 of what is specified by the standard. These behaviors should be left intact
6363 whenever possible, unless the standard explicitly disallows something. This
0 commit comments