summaryrefslogtreecommitdiff
path: root/numpy/core/arrayprint.py
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2017-09-23 13:54:24 -0500
committerGitHub <noreply@github.com>2017-09-23 13:54:24 -0500
commit7365323e720a8005f491ef62fbacf3d5f8f0151c (patch)
tree610bc0715aa4f6df09dcf6431d3952707c12eb05 /numpy/core/arrayprint.py
parent362e9d0eca4ce3d4b3a536f03f188a8f1e6f077c (diff)
parentad4daf62b8e6daee30a28762b8059f949f77be84 (diff)
downloadnumpy-7365323e720a8005f491ef62fbacf3d5f8f0151c.tar.gz
Merge pull request #8722 from wirawan0/master
DOC: Clarifying the meaning of small values for `suppress` print option.
Diffstat (limited to 'numpy/core/arrayprint.py')
-rw-r--r--numpy/core/arrayprint.py7
1 files changed, 5 insertions, 2 deletions
diff --git a/numpy/core/arrayprint.py b/numpy/core/arrayprint.py
index 46fbc9e5d..b8e60562f 100644
--- a/numpy/core/arrayprint.py
+++ b/numpy/core/arrayprint.py
@@ -93,8 +93,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).
+ 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