summaryrefslogtreecommitdiff
path: root/numpy/matrixlib/defmatrix.py
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2014-09-29 20:50:06 -0600
committerCharles Harris <charlesr.harris@gmail.com>2014-09-29 20:50:06 -0600
commitf401e7fbe283a5180052b140f1a2614f07b4bd77 (patch)
treec582bbf57b293be45d59d084dc4cbfa801603a2e /numpy/matrixlib/defmatrix.py
parent6a4aa598e3fa8c71489723f7223606a709836b80 (diff)
parent8b44a21c62a33337f611db411cfd912d1e8a2072 (diff)
downloadnumpy-f401e7fbe283a5180052b140f1a2614f07b4bd77.tar.gz
Merge pull request #5092 from jaimefrio/bmat_ldict_gdict
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
-------