Skip to content

Commit ad3156d

Browse files
authored
Some small fixes to function signatures to make them valid Python (#174)
* Some small fixes to function signatures to make them valid Python * Fix an issue that was breaking the spec parsing in the test suite * Call the argument to broadcast_arrays 'arrays' This is consistent with meshgrid().
1 parent 3eded25 commit ad3156d

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

spec/API_specification/array_object.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,7 @@ Returns `self[key]`.
598598

599599
#### Parameters
600600

601-
- **self**: _<array;>_
601+
- **self**: _<array>_
602602

603603
- array instance.
604604

spec/API_specification/creation_functions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ Returns evenly spaced numbers over a specified interval.
290290
- a one-dimensional array containing evenly spaced values.
291291
292292
(function-meshgrid)=
293-
### meshgrid(*arrays, /, *, indexing='xy')
293+
### meshgrid(*arrays, indexing='xy')
294294
295295
Returns coordinate matrices from coordinate vectors.
296296

spec/API_specification/data_type_functions.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ A conforming implementation of the array API standard must provide and support t
77
<!-- NOTE: please keep the constants in alphabetical order -->
88

99
## Objects in API
10-
(function-broadcast-arrays)=
11-
### broadcast_arrays(\*args, /)
10+
(function-broadcast_arrays)=
11+
### broadcast_arrays(*arrays)
1212

1313
Broadcasts one or more arrays against one another.
1414

1515
#### Parameters
1616

17-
- **\*args**: _Sequence\[ &lt;array&gt; ]_
17+
- **arrays**: _Sequence\[ &lt;array&gt; ]_
1818

1919
- arrays to broadcast.
2020

@@ -24,7 +24,7 @@ Broadcasts one or more arrays against one another.
2424

2525
- a list of broadcasted arrays. Each array must have the same shape. Each array must have the same dtype as its corresponding input array.
2626

27-
(function-broadcast-to)=
27+
(function-broadcast_to)=
2828
### broadcast_to(x, shape, /)
2929

3030
Broadcasts an array to a specified shape.
@@ -49,14 +49,14 @@ Broadcasts an array to a specified shape.
4949

5050
- if the array is incompatible with the specified shape (see {ref}`broadcasting`).
5151

52-
(function-can-cast)=
53-
### can_cast(from, to, /)
52+
(function-can_cast)=
53+
### can_cast(from_, to, /)
5454

5555
Determines if one data type can be cast to another data type according {ref}`type-promotion` rules.
5656

5757
#### Parameters
5858

59-
- **from**: _Union\[ &lt;dtype&gt;, &lt;array&gt;]_
59+
- **from_**: _Union\[ &lt;dtype&gt;, &lt;array&gt;]_
6060

6161
- input data type or array from which to cast.
6262

0 commit comments

Comments
 (0)