diff options
| author | Tapajyoti Bose <44058757+ruppysuppy@users.noreply.github.com> | 2020-07-01 00:47:24 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-30 12:17:24 -0700 |
| commit | 4dc50ca33258c587cb8034d5c91d561343e97fc8 (patch) | |
| tree | 195e4a43c12ae017f5a589069df0fee9cc09aa8e | |
| parent | a41d513df0bc100e36973d634b95ba86f710a508 (diff) | |
| download | numpy-4dc50ca33258c587cb8034d5c91d561343e97fc8.tar.gz | |
DOC: Updated documentation for numpy.squeeze (#16627)
DOC: Updated documentation for squeeze
Improve clarity by replacing terms like "single-dimensional" and
"singleton dimension" with "axes of length one"
| -rw-r--r-- | numpy/core/_add_newdocs.py | 2 | ||||
| -rw-r--r-- | numpy/core/fromnumeric.py | 6 | ||||
| -rw-r--r-- | numpy/matrixlib/defmatrix.py | 2 |
3 files changed, 5 insertions, 5 deletions
diff --git a/numpy/core/_add_newdocs.py b/numpy/core/_add_newdocs.py index 33c1f08b1..2461971eb 100644 --- a/numpy/core/_add_newdocs.py +++ b/numpy/core/_add_newdocs.py @@ -3751,7 +3751,7 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('squeeze', """ a.squeeze(axis=None) - Remove single-dimensional entries from the shape of `a`. + Remove axes of length one from `a`. Refer to `numpy.squeeze` for full documentation. diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index c1a220dfd..a9f3f1069 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -1438,7 +1438,7 @@ def _squeeze_dispatcher(a, axis=None): @array_function_dispatch(_squeeze_dispatcher) def squeeze(a, axis=None): """ - Remove single-dimensional entries from the shape of an array. + Remove axes of length one from `a`. Parameters ---------- @@ -1447,7 +1447,7 @@ def squeeze(a, axis=None): axis : None or int or tuple of ints, optional .. versionadded:: 1.7.0 - Selects a subset of the single-dimensional entries in the + Selects a subset of the entries of length one in the shape. If an axis is selected with shape entry greater than one, an error is raised. @@ -1466,7 +1466,7 @@ def squeeze(a, axis=None): See Also -------- - expand_dims : The inverse operation, adding singleton dimensions + expand_dims : The inverse operation, adding entries of length one reshape : Insert, remove, and combine dimensions, and resize existing ones Examples diff --git a/numpy/matrixlib/defmatrix.py b/numpy/matrixlib/defmatrix.py index a9ee74a5b..a414ee9bb 100644 --- a/numpy/matrixlib/defmatrix.py +++ b/numpy/matrixlib/defmatrix.py @@ -329,7 +329,7 @@ class matrix(N.ndarray): Parameters ---------- axis : None or int or tuple of ints, optional - Selects a subset of the single-dimensional entries in the shape. + Selects a subset of the axes of length one in the shape. If an axis is selected with shape entry greater than one, an error is raised. |