summaryrefslogtreecommitdiff
path: root/numpy/matrixlib/defmatrix.py
diff options
context:
space:
mode:
authorjaimefrio <jaime.frio@gmail.com>2014-09-20 18:02:36 -0700
committerjaimefrio <jaime.frio@gmail.com>2014-09-20 20:58:54 -0700
commit8b44a21c62a33337f611db411cfd912d1e8a2072 (patch)
tree93d0fe3987748d12de2b1396a6eb5fe519148a2a /numpy/matrixlib/defmatrix.py
parent2e3778a189afafce5b0d3c62b93075e253cfba0f (diff)
downloadnumpy-8b44a21c62a33337f611db411cfd912d1e8a2072.tar.gz
DOC: document `ldict` and `gdict` in bmat, closes #5058
Diffstat (limited to 'numpy/matrixlib/defmatrix.py')
-rw-r--r--numpy/matrixlib/defmatrix.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/numpy/matrixlib/defmatrix.py b/numpy/matrixlib/defmatrix.py
index 22ff4790b..d0b39ad9f 100644
--- a/numpy/matrixlib/defmatrix.py
+++ b/numpy/matrixlib/defmatrix.py
@@ -1161,6 +1161,12 @@ def bmat(obj, ldict=None, gdict=None):
obj : str or array_like
Input data. Names of variables in the current scope may be
referenced, even if `obj` is a string.
+ ldict : dict, optional
+ A dictionary that replaces local operands in current frame.
+ Ignored if `obj` is not a string or `gdict` is `None`.
+ gdict : dict, optional
+ A dictionary that replaces global operands in current frame.
+ Ignored if `obj` is not a string.
Returns
-------