Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
rgommers opened this issue Jul 14, 2021 · 0 comments · Fixed by #576
Closed

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

rgommers opened this issue Jul 14, 2021 · 0 comments · Fixed by #576
Assignees
Labels
Maintenance Bug fix, typo fix, or general maintenance.
Milestone

Comments

@rgommers
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintenance Bug fix, typo fix, or general maintenance.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants