summaryrefslogtreecommitdiff
path: root/numpy/doc/broadcasting.py
diff options
context:
space:
mode:
authornjsmith <njs@pobox.com>2014-02-24 18:50:04 -0500
committernjsmith <njs@pobox.com>2014-02-24 18:50:04 -0500
commitf8bcb8802af1b5ba5b4c9a67109095e8072a041a (patch)
tree3a51a9fd27a492a12e44f9b4462fc58ce10f2691 /numpy/doc/broadcasting.py
parent42c8ced9257869a3897d84e2d5da570ddbb5fc59 (diff)
downloadnumpy-f8bcb8802af1b5ba5b4c9a67109095e8072a041a.tar.gz
[DOC] Fix small inaccuracy in broadcasting docs
During broadcasting, dimensions with size 1 can be matched against 0-sized dimensions, and in this case it's the size 1 dimension that will be shrunk away to nothingness. So it's wrong to say that the *smaller* dimension is the one that changes.
Diffstat (limited to 'numpy/doc/broadcasting.py')
-rw-r--r--numpy/doc/broadcasting.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/numpy/doc/broadcasting.py b/numpy/doc/broadcasting.py
index 43b725b83..d6069a0fa 100644
--- a/numpy/doc/broadcasting.py
+++ b/numpy/doc/broadcasting.py
@@ -68,8 +68,8 @@ they are compatible::
Scale (1d array): 3
Result (3d array): 256 x 256 x 3
-When either of the dimensions compared is one, the larger of the two is
-used. In other words, the smaller of two axes is stretched or "copied"
+When either of the dimensions compared is one, the other is
+used. In other words, dimensions with size 1 are stretched or "copied"
to match the other.
In the following example, both the ``A`` and ``B`` arrays have axes with