diff options
author | Pauli Virtanen <pav@iki.fi> | 2008-10-28 00:13:44 +0000 |
---|---|---|
committer | Pauli Virtanen <pav@iki.fi> | 2008-10-28 00:13:44 +0000 |
commit | 18594cd9653a865fddfa4cd81f82ab54430be1c9 (patch) | |
tree | 04db708f8a8a3575d129390342ff789ef6f1e170 /numpy/core/arrayprint.py | |
parent | 7a70f54f515bb8c586c3967d62731a49217eef95 (diff) | |
download | numpy-18594cd9653a865fddfa4cd81f82ab54430be1c9.tar.gz |
Import documentation from doc wiki (part 2, work-in-progress docstrings, but they are still an improvement)
Diffstat (limited to 'numpy/core/arrayprint.py')
-rw-r--r-- | numpy/core/arrayprint.py | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/numpy/core/arrayprint.py b/numpy/core/arrayprint.py index 8400802f7..98df924e7 100644 --- a/numpy/core/arrayprint.py +++ b/numpy/core/arrayprint.py @@ -42,23 +42,23 @@ def set_printoptions(precision=None, threshold=None, edgeitems=None, Parameters ---------- - precision : int + precision : int, optional Number of digits of precision for floating point output (default 8). - threshold : int + threshold : int, optional Total number of array elements which trigger summarization rather than full repr (default 1000). - edgeitems : int + edgeitems : int, optional Number of array items in summary at beginning and end of each dimension (default 3). - linewidth : int + linewidth : int, optional The number of characters per line for the purpose of inserting line breaks (default 75). - suppress : bool + suppress : bool, optional Whether or not suppress printing of small floating point values using scientific notation (default False). - nanstr : string + nanstr : string, optional String representation of floating point not-a-number (default nan). - infstr : string + infstr : string, optional String representation of floating point infinity (default inf). Examples @@ -242,7 +242,8 @@ def array2string(a, max_line_width = None, precision = None, The maximum number of columns the string should span. Newline characters splits the string appropriately after array elements. precision : int, optional - Floating point precision. + Floating point precision. Default is the current printing + precision (usually 8), which can be altered using `set_printoptions`. suppress_small : bool, optional Represent very small numbers as zero. separator : string, optional @@ -259,7 +260,7 @@ def array2string(a, max_line_width = None, precision = None, See Also -------- - array_str, array_repr + array_str, array_repr, set_printoptions Examples -------- |