Skip to content

Refactor the boilerplate text at the top of each API spec section #223

Closed
@rgommers

Description

@rgommers

Following up on review comments at #189 (comment): there's this bit of boilerplate that is repeated over and over in each API docs section. We should put that in a single place, and refer to it in a concise as possible way:

-   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.
-   Optional parameters must be [keyword-only](https://www.python.org/dev/peps/pep-3102/) arguments.
-   Broadcasting semantics must follow the semantics defined in {ref}`broadcasting`.
-   Unless stated otherwise, functions must support the data types defined in {ref}`data-types`.
-   Unless stated otherwise, functions must adhere to the type promotion rules defined in {ref}`type-promotion`.
-   Unless stated otherwise, floating-point operations must adhere to IEEE 754-2019.

There's already https://data-apis.org/array-api/latest/API_specification/function_and_method_signatures.html which looks like the right place to add it to.

Metadata

Metadata

Assignees

Labels

MaintenanceBug fix, typo fix, or general maintenance.

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions