From dafb597e9d03607130c25afbee3d4bec34a68866 Mon Sep 17 00:00:00 2001
From: Ralf Gommers <ralf.gommers@googlemail.com>
Date: Wed, 18 Mar 2015 07:44:30 +0100
Subject: DOC: add array2string to reference guide and explain relation to
 array_repr/str

Closes gh-5684.

[ci skip]
---
 numpy/core/arrayprint.py | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'numpy/core/arrayprint.py')

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])
-- 
cgit v1.2.1