summaryrefslogtreecommitdiff
path: root/numpy/core/arrayprint.py
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2017-09-23 12:49:12 -0600
committerGitHub <noreply@github.com>2017-09-23 12:49:12 -0600
commitad4daf62b8e6daee30a28762b8059f949f77be84 (patch)
tree7ea4fb2a9c49fddd437a0da9fc0892e10be1cd13 /numpy/core/arrayprint.py
parent63997b533673ef60cc85c14ff46b543dc7bbcfc7 (diff)
downloadnumpy-ad4daf62b8e6daee30a28762b8059f949f77be84.tar.gz
MAINT: Clarify of the suppress print option more.
Diffstat (limited to 'numpy/core/arrayprint.py')
-rw-r--r--numpy/core/arrayprint.py9
1 files changed, 5 insertions, 4 deletions
diff --git a/numpy/core/arrayprint.py b/numpy/core/arrayprint.py
index 64d241fe0..c10d9c11e 100644
--- a/numpy/core/arrayprint.py
+++ b/numpy/core/arrayprint.py
@@ -69,10 +69,11 @@ def set_printoptions(precision=None, threshold=None, edgeitems=None,
The number of characters per line for the purpose of inserting
line breaks (default 75).
suppress : bool, optional
- Whether or not suppress printing of small floating point values
- using scientific notation (default False).
- A number is "very small" if it is smaller than the current printing
- precision.
+ If True, always print floating point numbers using fixed point
+ notation, in which case numbers equal to zero in the current precision
+ will print as zero. If False, then scientific notation is used when
+ absolute value of the smallest number is < 1e-4 or the ratio of the
+ maximum absolute value to the minimum is > 1e3. The default is False.
nanstr : str, optional
String representation of floating point not-a-number (default nan).
infstr : str, optional