Merge pull request #26488 from luxedo/add-get_printoptions-example

mattip · web-flow · commit 5848b4e572d2 · 2024-05-21T11:07:45.000+03:00
DOC: add examples to get_printoptions
diff --git a/numpy/_core/arrayprint.py b/numpy/_core/arrayprint.py
@@ -329,6 +329,18 @@ def get_printoptions():
     --------
     set_printoptions, printoptions
 
+    Examples
+    --------
+
+    >>> np.get_printoptions()
+    {'edgeitems': 3, 'threshold': 1000, ..., 'legacy': False}
+
+    >>> np.get_printoptions()['linewidth']
+    75
+    >>> np.set_printoptions(linewidth=100)
+    >>> np.get_printoptions()['linewidth']
+    100
+
     """
     opts = _format_options.copy()
     opts['legacy'] = {
