summaryrefslogtreecommitdiff
path: root/numpy
diff options
context:
space:
mode:
authorWarren Weckesser <warren.weckesser@gmail.com>2013-06-02 13:38:11 -0400
committerWarren Weckesser <warren.weckesser@gmail.com>2013-06-02 13:38:11 -0400
commit6eb57a767713a7a2b74e1cd3365c34638ec55eac (patch)
treebb404f76ff71d8493cd3620069d5c1af72ded6ed /numpy
parent3bdb6099e6090f433a85d363b8ee7b1de0233571 (diff)
downloadnumpy-6eb57a767713a7a2b74e1cd3365c34638ec55eac.tar.gz
DOC: linalg: Improve the docstring of the new norm function.
Diffstat (limited to 'numpy')
-rw-r--r--numpy/linalg/linalg.py7
1 files changed, 4 insertions, 3 deletions
diff --git a/numpy/linalg/linalg.py b/numpy/linalg/linalg.py
index a2335b1d3..2bc56f978 100644
--- a/numpy/linalg/linalg.py
+++ b/numpy/linalg/linalg.py
@@ -1876,14 +1876,15 @@ def norm(x, ord=None, axis=None):
Parameters
----------
- x : {(M,), (M, N)} array_like
- Input array.
+ x : array_like
+ Input array. If `axis` is None, `x` must be 1-D or 2-D.
ord : {non-zero int, inf, -inf, 'fro'}, optional
Order of the norm (see table under ``Notes``). inf means numpy's
`inf` object.
axis : int or None, optional
If `axis` is not None, it specifies the axis of `x` along which to
- compute the vector norms.
+ compute the vector norms. If `axis` is None, then either a vector
+ norm (when `x` is 1-D) or a matrix norm (when `x` is 2-D) is returned.
Returns
-------