summaryrefslogtreecommitdiff
path: root/doc/source/reference
diff options
context:
space:
mode:
authorAaron Meurer <asmeurer@gmail.com>2022-06-08 17:18:17 -0600
committerAaron Meurer <asmeurer@gmail.com>2022-06-08 17:21:22 -0600
commit827dac7439d3d6f04368b501d7cf715704e63e55 (patch)
tree21871f5f76e38888bda474b86d9cbccf95c0cf87 /doc/source/reference
parent3523b578f60b4b584f951f0ffaf89703bc3e07b3 (diff)
downloadnumpy-827dac7439d3d6f04368b501d7cf715704e63e55.tar.gz
Mention positional-only arguments in the array API compatibility doc
I forgot to mention them, but they are important because this would be a breaking change.
Diffstat (limited to 'doc/source/reference')
-rw-r--r--doc/source/reference/array_api.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/source/reference/array_api.rst b/doc/source/reference/array_api.rst
index a6a8619da..8c7c6508b 100644
--- a/doc/source/reference/array_api.rst
+++ b/doc/source/reference/array_api.rst
@@ -801,3 +801,8 @@ Other Differences
- **Strictness**
- The spec allows duck typing, so ``finfo`` returning dtype
scalars is considered type compatible with ``float``.
+ * - Positional arguments in every function are positional-only.
+ - **Breaking**
+ - See the spec for the exact signature of each function. Note that NumPy
+ ufuncs already use positional-only arguments, but non-ufuncs like
+ ``asarray`` generally do not.