diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2018-05-14 15:12:33 -0600 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-05-14 15:12:33 -0600 |
commit | 8e74c991d1336bd51e71dc492544223055c130f4 (patch) | |
tree | a03ce94caeae0ae3e57cf63830d430a734c806be /numpy/core/fromnumeric.py | |
parent | 7c7ad152867928a3b4b6d5d5ff6c5e266360c6be (diff) | |
download | numpy-8e74c991d1336bd51e71dc492544223055c130f4.tar.gz |
DOC: Revise some of the docstrings.
[ci skip]
Diffstat (limited to 'numpy/core/fromnumeric.py')
-rw-r--r-- | numpy/core/fromnumeric.py | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index 58903d411..0db5663f9 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -1336,10 +1336,11 @@ def diagonal(a, offset=0, axis1=0, axis2=1): Returns ------- array_of_diagonals : ndarray - If `a` is 2-D, a 1-D array of the same type as `a` containing the - diagonal is returned (except if `a` is a `matrix`, in which case a 1-D - array containing the diagonal is returned in order to maintain - backward compatibility). + If `a` is 2-D, then a 1-D array containing the diagonal and of the + same type as `a` is returned unless `a` is a `matrix`, in which case + a 1-D array rather than a (2-D) `matrix` is returned in order to + maintain backward compatibility. + If ``a.ndim > 2``, then the dimensions specified by `axis1` and `axis2` are removed, and a new axis inserted at the end corresponding to the diagonal. @@ -1496,9 +1497,9 @@ def ravel(a, order='C'): Returns ------- y : array_like - y is an array of the same subtype as `a`, with shape ``(a.size,)`` - (Note: matrices are special-cases for backward compatibility: if `a` - is a matrix, y is a 1-D ndarray.) + y is an array of the same subtype as `a`, with shape ``(a.size,)``. + Note that matrices are special cased for backward compatibility, if `a` + is a matrix, then y is a 1-D ndarray. See Also -------- |