From b93b0b879b1c6c35412e599786221dff5730bac0 Mon Sep 17 00:00:00 2001
From: Samesh Lakhotia <43701530+sameshl@users.noreply.github.com>
Date: Wed, 10 Jul 2019 00:36:35 +0530
Subject: DOC:Update the description of set_printoptions in quickstart doc
 #13900 (#13948)

Quickstart guide recommends np.set_printoptions(threshold=np.nan) but that fails.
So changed that to np.set_printoptions(threshold=sys.maxsize)

Closes #13900

* DOC:Update the docstring of set_printoptions

Add preferred max value for threshold is sys.maxsize

* Revert "DOC:Update the docstring of set_printoptions"

This reverts commit 9641121fcb84b9ad5edb188a4a5b4ac9361fbf0b.

* DOC:Update the docstring of set_printoptions

Add preferred max value for threshold is sys.maxsize

* DOC:Update the docstring of set_printoptions

Better pharasing in docstring.

* DOC:Update the description of set_printoptions in quickstart doc #13900

Fix indentation
---
 numpy/core/arrayprint.py | 1 +
 1 file changed, 1 insertion(+)

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

diff --git a/numpy/core/arrayprint.py b/numpy/core/arrayprint.py
index 739ae7711..108364824 100644
--- a/numpy/core/arrayprint.py
+++ b/numpy/core/arrayprint.py
@@ -114,6 +114,7 @@ def set_printoptions(precision=None, threshold=None, edgeitems=None,
     threshold : int, optional
         Total number of array elements which trigger summarization
         rather than full repr (default 1000).
+        To always use the full repr without summarization, pass `sys.maxsize`.
     edgeitems : int, optional
         Number of array items in summary at beginning and end of
         each dimension (default 3).
-- 
cgit v1.2.1