summaryrefslogtreecommitdiff
path: root/numpy/_array_api/_manipulation_functions.py
diff options
context:
space:
mode:
authorAaron Meurer <asmeurer@gmail.com>2021-01-12 16:36:41 -0700
committerAaron Meurer <asmeurer@gmail.com>2021-01-12 16:36:41 -0700
commit00dda8df893d2df8730e0977178f1a116ec9cf91 (patch)
tree8fd3baffd85940472245c2fe7310868f34c7a819 /numpy/_array_api/_manipulation_functions.py
parenta78d20a279b3f081367109338c78ab20e08c642c (diff)
downloadnumpy-00dda8df893d2df8730e0977178f1a116ec9cf91.tar.gz
Add basic docstrings to the array API wrapper functions
The docstrings just point back to the functions they wrap for now. More thought may need to be put into this for the future. Most functions can actually perhaps inherit the docstring of the function they wrap directly, but there are some functions that have differences (e.g., different names, different keyword arguments, fewer keyword arguments, etc.). There's also the question of how to handle cross-references/see alsos that point to functions not in the API spec and behavior shown in docstring examples that isn't required in the spec.
Diffstat (limited to 'numpy/_array_api/_manipulation_functions.py')
-rw-r--r--numpy/_array_api/_manipulation_functions.py35
1 files changed, 35 insertions, 0 deletions
diff --git a/numpy/_array_api/_manipulation_functions.py b/numpy/_array_api/_manipulation_functions.py
index 262c712f8..834aa2f8f 100644
--- a/numpy/_array_api/_manipulation_functions.py
+++ b/numpy/_array_api/_manipulation_functions.py
@@ -1,23 +1,58 @@
import numpy as np
def concat(arrays, /, *, axis=0):
+ """
+ Array API compatible wrapper for :py:func:`np.concatenate <numpy.concatenate>`.
+
+ See its docstring for more information.
+ """
# Note: the function name is different here
return np.concatenate(arrays, axis=axis)
def expand_dims(x, axis, /):
+ """
+ Array API compatible wrapper for :py:func:`np.expand_dims <numpy.expand_dims>`.
+
+ See its docstring for more information.
+ """
return np.expand_dims(x, axis)
def flip(x, /, *, axis=None):
+ """
+ Array API compatible wrapper for :py:func:`np.flip <numpy.flip>`.
+
+ See its docstring for more information.
+ """
return np.flip(x, axis=axis)
def reshape(x, shape, /):
+ """
+ Array API compatible wrapper for :py:func:`np.reshape <numpy.reshape>`.
+
+ See its docstring for more information.
+ """
return np.reshape(x, shape)
def roll(x, shift, /, *, axis=None):
+ """
+ Array API compatible wrapper for :py:func:`np.roll <numpy.roll>`.
+
+ See its docstring for more information.
+ """
return np.roll(x, shift, axis=axis)
def squeeze(x, /, *, axis=None):
+ """
+ Array API compatible wrapper for :py:func:`np.squeeze <numpy.squeeze>`.
+
+ See its docstring for more information.
+ """
return np.squeeze(x, axis=axis)
def stack(arrays, /, *, axis=0):
+ """
+ Array API compatible wrapper for :py:func:`np.stack <numpy.stack>`.
+
+ See its docstring for more information.
+ """
return np.stack(arrays, axis=axis)