summaryrefslogtreecommitdiff
path: root/numpy/matrixlib/defmatrix.py
diff options
context:
space:
mode:
authoralex <argriffi@ncsu.edu>2014-07-31 20:26:30 -0400
committeralex <argriffi@ncsu.edu>2014-07-31 20:26:30 -0400
commit489d23cd0f08de8890a65dcdb5caccdb8030c646 (patch)
tree0d974f29b344995a5312149770e9b51c0260c52a /numpy/matrixlib/defmatrix.py
parentfdedd16f31ee8f35b500d3585bf934b97154d878 (diff)
downloadnumpy-489d23cd0f08de8890a65dcdb5caccdb8030c646.tar.gz
DOC: clarify that matrix.ravel only copies if necessary; this is already tested
Diffstat (limited to 'numpy/matrixlib/defmatrix.py')
-rw-r--r--numpy/matrixlib/defmatrix.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/numpy/matrixlib/defmatrix.py b/numpy/matrixlib/defmatrix.py
index 51903e258..752bfdae5 100644
--- a/numpy/matrixlib/defmatrix.py
+++ b/numpy/matrixlib/defmatrix.py
@@ -952,8 +952,9 @@ class matrix(N.ndarray):
Returns
-------
ret : matrix
- A copy of the matrix, flattened to a `(1, N)` matrix where `N`
+ Return the matrix flattened to shape `(1, N)` where `N`
is the number of elements in the original matrix.
+ A copy is made only if necessary.
See Also
--------