Changeset 4405:983ae7c2cfd0

Timestamp:

05/10/07 23:18:53 (6 years ago)

Author:

William Stein <wstein@…>

Branch:

default

Message:

plot doc improvements

Location:

sage

Files:

• misc/functional.py (modified) (1 diff)
• plot/plot.py (modified) (3 diffs)

sage/misc/functional.py

@@ -782 +782 @@
     """
     Show a graphics object x.
+
+    OPTIONAL INPUT:
+        filename -- (default: None) string
+        dpi -- dots per inch
+        figsize -- [width, height] (same for square aspect)
+        axes -- (default: True)
+        fontsize -- positive integer
+        frame -- (default: False) draw a MATLAB-like frame around the image
     """
     if not isinstance(x, (sage.interfaces.expect.Expect, sage.interfaces.expect.ExpectElement)):

sage/plot/plot.py

@@ -629 +629 @@
         Show this graphics image with the default image viewer.
         
+        OPTIONAL INPUT:
+            filename -- (default: None) string
+            dpi -- dots per inch
+            figsize -- [width, height] (same for square aspect)
+            axes -- (default: True)
+            fontsize -- positive integer
+            frame -- (default: False) draw a MATLAB-like frame around the image
+
         EXAMPLES:
             sage: c = circle((1,1), 1, rgbcolor=(1,0,0))
@@ -1717 +1725 @@
 class CircleFactory(GraphicPrimitiveFactory_circle):
     """
-    
-    A circle at a point = (x,y) with radius = r
+    Return a circle at a point = (x,y) with radius = r.
     Type circle.options to see all options
 
+    circle(center, radius, **kwds)
+
+    INPUT:
+        center -- a 2-tuple (x,y)
+        radius -- a positive number
+        alpha -- default: 1
+        fill -- default: False
+        thickness -- default: 1
+        rgbcolor -- default: (0,0,0)
+
     EXAMPLES:
-    sage: c = circle((1,1),1,rgbcolor=(1,0,0))
-    sage: c.save()
+        sage: c = circle((1,1), 1, rgbcolor=(1,0,0))
+        sage: c.save()
 
     To correct the apect ratio of certain graphics, it is necessary
@@ -2756 +2773 @@
         r"""
         Show this graphics array using the default viewer.
+
+        OPTIONAL INPUT:
+            filename -- (default: None) string
+            dpi -- dots per inch
+            figsize -- [width, height] (same for square aspect)
+            axes -- (default: True)
+            fontsize -- positive integer
+            frame -- (default: False) draw a MATLAB-like frame around the image
         """
         if (figsize != DEFAULT_FIGSIZE): self.__set_figsize__(figsize)