Changeset 4318:9749e933ad06

Timestamp:

05/05/07 13:32:46 (6 years ago)

Author:

William Stein <wstein@…>

Branch:

default

Message:

Enable show_default function for plotting; also fix some docs as suggested by Brian Harris.

Location:

sage/plot

Files:

• all.py (modified) (1 diff)
• plot.py (modified) (2 diffs)

sage/plot/all.py

@@ -4 +4 @@
                   polar_plot, contour_plot, arrow,
                   plot_vector_field, matrix_plot, bar_chart,
-                  is_Graphics)
+                  is_Graphics,
+                  show_default)
 
 from plot3d import (Graphics3d, point3d, line3d)

sage/plot/plot.py

@@ -141 +141 @@
 EMBEDDED_MODE = False
 SHOW_DEFAULT = False
+
+def show_default(default=None):
+    """
+    Set the default for showing plots using the following commands:
+        plot, parametric_plot, polar_plot, and list_plot.
+
+    If called with no arguments, returns the current default.
+
+    EXAMPLES:
+    The default starts out as False:
+        sage: show_default()
+        False
+
+    We set it to True.  
+        sage: show_default(True)
+
+    We see that it is True.
+        sage: show_default()
+        True
+
+    Now certain plot commands will display their plots by default.
+
+    Turn of default display.
+        sage: show_default(False)
+
+    """
+    global SHOW_DEFAULT
+    if default is None:
+        return SHOW_DEFAULT
+    SHOW_DEFAULT = bool(default)
 
 do_verify = True
@@ -2433 +2463 @@
         tmin -- start value of t
         tmax -- end value of t
-        show -- whether or not to show the plot immediately (default: True)
+        show -- bool or None
+                (default: use the default as set by the show_default command)
+                 whether or not to show the plot immediately
         other options -- passed to plot.