summaryrefslogtreecommitdiff
path: root/numpy/core/arrayprint.py
diff options
context:
space:
mode:
authorRalf Gommers <ralf.gommers@googlemail.com>2015-03-18 07:44:30 +0100
committerRalf Gommers <ralf.gommers@googlemail.com>2015-03-18 07:44:30 +0100
commitdafb597e9d03607130c25afbee3d4bec34a68866 (patch)
treee09c5298a51e3ad6579a3062e9d429a86bbb1dd2 /numpy/core/arrayprint.py
parentc60f1c6d944b25c5a001cf80e9b65dd5d44ed85d (diff)
downloadnumpy-dafb597e9d03607130c25afbee3d4bec34a68866.tar.gz
DOC: add array2string to reference guide and explain relation to array_repr/str
Closes gh-5684. [ci skip]
Diffstat (limited to 'numpy/core/arrayprint.py')
-rw-r--r--numpy/core/arrayprint.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/numpy/core/arrayprint.py b/numpy/core/arrayprint.py
index 125d57672..2dc56928c 100644
--- a/numpy/core/arrayprint.py
+++ b/numpy/core/arrayprint.py
@@ -417,6 +417,10 @@ def array2string(a, max_line_width=None, precision=None,
If a formatter is specified for a certain type, the `precision` keyword is
ignored for that type.
+ This is a very flexible function; `array_repr` and `array_str` are using
+ `array2string` internally so keywords with the same name should work
+ identically in all three functions.
+
Examples
--------
>>> x = np.array([1e-16,1,2,3])