Skip to content

Commit fe645ff

Browse files
committed
Some small docs changes
1 parent fd4b0ed commit fe645ff

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

Diff for: docs/dev/implementation-notes.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,10 @@ should be taken into account:
3737
other than wrappers for functions in the standard, and basic [helper
3838
functions](../helper-functions.rst) that would be useful for most users of
3939
array-api-compat. The addition of functions that are not part of the array
40-
API standard is currently out-of-scope for this package.
40+
API standard is currently out-of-scope for this package (see the
41+
[Scope](scope) section of the documentation).
4142

42-
- *No Side-effects*. array-api-compat behavior should be localized to only the
43+
- *No Side-Effects*. array-api-compat behavior should be localized to only the
4344
specific code that imports and uses it. It should be invisible to end-users
4445
or users of dependent codes. This in particular implies to the next two
4546
points.
@@ -51,8 +52,8 @@ should be taken into account:
5152
library cannot be modified. This also precludes the creation of array
5253
subclasses or wrapper classes.
5354

54-
Any behavior that is built-in to the array object, such as the behavior of
55-
[array
55+
Any non-standard behavior that is built-in to the array object, such as the
56+
behavior of [array
5657
methods](https://data-apis.org/array-api/latest/API_specification/array_object.html),
5758
is therefore left unwrapped. Users can workaround issues by using
5859
corresponding [elementwise

Diff for: docs/supported-array-libraries.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,11 @@ version.
6666
functions {func}`~.array_namespace()` and {func}`~.to_device()` in this
6767
library should be used instead.
6868

69-
- The `x.size` attribute on `torch.Tensor` is a function that behaves
70-
differently from
69+
- The {external+torch:meth}`x.size() <torch.Tensor.size>` attribute on
70+
`torch.Tensor` is a method that behaves differently from the
7171
[`x.size`](https://data-apis.org/array-api/draft/API_specification/generated/array_api.array.size.html)
72-
in the spec. Use the {func}`~.size()` helper function as a portable
73-
workaround.
72+
attribute in the spec. Use the {func}`~.size()` helper function as a
73+
portable workaround.
7474

7575
- PyTorch does not have unsigned integer types other than `uint8`, and no
7676
attempt is made to implement them here.

0 commit comments

Comments
 (0)