Skip to content

Commit ef6690e

Browse files
committed
Clean up duplicate blurbs on function conventions; improve fft description
1 parent 6d07556 commit ef6690e

15 files changed

+42
-90
lines changed

spec/API_specification/array_object.rst

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,7 @@ Array object
55

66
Array API specification for array object attributes and methods.
77

8-
A conforming implementation of the array API standard must provide and support an array object having the following attributes and methods adhering to the following conventions.
9-
10-
* Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a method accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
11-
* Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments.
12-
* Broadcasting semantics must follow the semantics defined in :ref:`broadcasting`.
13-
* Unless stated otherwise, methods must support the data types defined in :ref:`data-types`.
14-
* Unless stated otherwise, methods must adhere to the type promotion rules defined in :ref:`type-promotion`.
15-
* Unless stated otherwise, floating-point operations must adhere to IEEE 754-2019.
8+
A conforming implementation of the array API standard must provide and support an array object having the following attributes and methods.
169

1710
Furthermore, a conforming implementation of the array API standard must support array objects of arbitrary rank ``N`` (i.e., number of dimensions), where ``N`` is greater than or equal to zero.
1811

spec/API_specification/creation_functions.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@ Creation Functions
33

44
Array API specification for creating arrays.
55

6-
A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.
6+
A conforming implementation of the array API standard must provide and support the following functions.
77

8-
- Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
9-
- Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments.
108

119
Objects in API
1210
--------------

spec/API_specification/elementwise_functions.rst

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,6 @@ Element-wise Functions
55

66
Array API specification for element-wise functions.
77

8-
A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.
9-
10-
- Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
11-
- Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments.
12-
- Broadcasting semantics must follow the semantics defined in :ref:`broadcasting`.
13-
- Unless stated otherwise, functions must support the data types defined in :ref:`data-types`.
14-
- Functions may only be required for a subset of input data type. Libraries may choose to implement functions for additional data types, but that behavior is not required by the specification. See :ref:`data-type-categories`.
15-
- Unless stated otherwise, functions must adhere to the type promotion rules defined in :ref:`type-promotion`.
16-
- Unless stated otherwise, floating-point operations must adhere to IEEE 754-2019.
17-
- Unless stated otherwise, element-wise mathematical functions must satisfy the minimum accuracy requirements defined in :ref:`accuracy`.
18-
198
Objects in API
209
--------------
2110

spec/API_specification/index.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
API specification
44
=================
55

6+
A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.
7+
8+
- Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters when the function signature indicates this (as denoted by `/`). See :ref:`function-and-method-signatures`.
9+
- Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ argumentswhen the function signature indicates this (as denoted by `*`). See :ref:`function-and-method-signatures`.
10+
- Broadcasting semantics must follow the semantics defined in :ref:`broadcasting`.
11+
- Unless stated otherwise, functions must support the data types defined in :ref:`data-types`.
12+
- Functions may only be required for a subset of input data types. Libraries may choose to implement functions for additional data types, but that behavior is not required by the specification. See :ref:`data-type-categories`.
13+
- Unless stated otherwise, functions must adhere to the type promotion rules defined in :ref:`type-promotion`.
14+
- Unless stated otherwise, floating-point operations must adhere to IEEE 754-2019.
15+
- Unless stated otherwise, element-wise mathematical functions must satisfy the minimum accuracy requirements defined in :ref:`accuracy`.
16+
17+
618
.. toctree::
719
:caption: API specification
820
:maxdepth: 3

spec/API_specification/indexing_functions.rst

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,8 @@ Indexing Functions
55

66
Array API specification for functions for indexing arrays.
77

8-
A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.
8+
A conforming implementation of the array API standard must provide and support the following functions.
99

10-
- Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
11-
- Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments.
12-
- Broadcasting semantics must follow the semantics defined in :ref:`broadcasting`.
13-
- Unless stated otherwise, functions must support the data types defined in :ref:`data-types`.
14-
- Unless stated otherwise, functions must adhere to the type promotion rules defined in :ref:`type-promotion`.
1510

1611
Objects in API
1712
--------------

spec/API_specification/linear_algebra_functions.rst

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,8 @@ Linear Algebra Functions
33

44
Array API specification for linear algebra functions.
55

6-
A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.
6+
A conforming implementation of the array API standard must provide and support the following functions.
77

8-
* Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
9-
* Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments.
10-
* Broadcasting semantics must follow the semantics defined in :ref:`broadcasting`.
11-
* Unless stated otherwise, functions must support the data types defined in :ref:`data-types`.
12-
* Unless stated otherwise, functions must adhere to the type promotion rules defined in :ref:`type-promotion`.
13-
* Unless stated otherwise, floating-point operations must adhere to IEEE 754-2019.
148

159
.. currentmodule:: array_api
1610

spec/API_specification/manipulation_functions.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,8 @@ Manipulation Functions
33

44
Array API specification for manipulating arrays.
55

6-
A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.
6+
A conforming implementation of the array API standard must provide and support the following functions.
77

8-
- Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
9-
- Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments.
10-
- Unless stated otherwise, functions must adhere to the type promotion rules defined in :ref:`type-promotion`.
118

129
Objects in API
1310
--------------

spec/API_specification/searching_functions.rst

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,8 @@ Searching Functions
55

66
Array API specification for functions for searching arrays.
77

8-
A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.
8+
A conforming implementation of the array API standard must provide and support the following functions.
99

10-
- Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
11-
- Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments.
12-
- Broadcasting semantics must follow the semantics defined in :ref:`broadcasting`.
13-
- Unless stated otherwise, functions must support the data types defined in :ref:`data-types`.
14-
- Unless stated otherwise, functions must adhere to the type promotion rules defined in :ref:`type-promotion`.
1510

1611
Objects in API
1712
--------------

spec/API_specification/set_functions.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,8 @@ Set Functions
33

44
Array API specification for creating and operating on sets.
55

6-
A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.
6+
A conforming implementation of the array API standard must provide and support the following functions.
77

8-
- Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
9-
- Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments.
10-
- Unless stated otherwise, functions must support the data types defined in :ref:`data-types`.
118

129
Objects in API
1310
--------------

spec/API_specification/sorting_functions.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,8 @@ Sorting Functions
33

44
Array API specification for sorting functions.
55

6-
A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.
6+
A conforming implementation of the array API standard must provide and support the following functions.
77

8-
* Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
9-
* Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments.
10-
* Unless stated otherwise, functions must support the data types defined in :ref:`data-types`.
118

129
.. note::
1310

0 commit comments

Comments
 (0)