Update various comments and docstrings

chaco/barplot.py

@@ -75,14 +75,14 @@ class BarPlot(AbstractPlotRenderer):
     #: Color to fill the bars.
     fill_color = black_color_trait
 
-    #: The RGBA tuple for rendering lines.  It is always a tuple of length 4.
-    #: It has the same RGB values as line_color_, and its alpha value is the
-    #: alpha value of self.line_color multiplied by self.alpha. 
+    #: The RGBA tuple for rendering lines. It is always a tuple of length 4.
+    #: It has the same RGB values as :attr:`line_color`, and its alpha value
+    #: is the alpha value of self.line_color multiplied by self.alpha.
     effective_line_color = Property(Tuple, depends_on=['line_color', 'alpha'])
-    
-    #: The RGBA tuple for rendering the fill.  It is always a tuple of length 4.
-    #: It has the same RGB values as fill_color_, and its alpha value is the
-    #: alpha value of self.fill_color multiplied by self.alpha.   
+
+    #: The RGBA tuple for rendering the fill. It is always a tuple of length
+    #: 4. It has the same RGB values as :attr:`fill_color`, and its alpha
+    #: value is the alpha value of self.fill_color multiplied by self.alpha.
     effective_fill_color = Property(Tuple, depends_on=['fill_color', 'alpha'])
 
     #: Overall alpha value of the image. Ranges from 0.0 for transparent to 1.0

chaco/lineplot.py

@@ -32,9 +32,9 @@ class LinePlot(BaseXYPlot):
     #: The color of the line.
     color = black_color_trait
 
-    #: The RGBA tuple for rendering lines.  It is always a tuple of length 4.
-    #: It has the same RGB values as color_, and its alpha value is the alpha
-    #: value of self.color multiplied by self.alpha.
+    #: The RGBA tuple for rendering lines. It is always a tuple of length 4.
+    #: It has the same RGB values as :attr:`color`, and its alpha value is the
+    #: alpha value of self.color multiplied by self.alpha.
     effective_color = Property(Tuple, depends_on=['color', 'alpha'])
 
     #: The color to use to highlight the line when selected.

chaco/polygon_plot.py

@@ -51,15 +51,15 @@ class PolygonPlot(BaseXYPlot):
 
     #: Override the hittest_type trait inherited from BaseXYPlot
     hittest_type = Enum("poly", "point", "line")
-    
-    #: The RGBA tuple for rendering edges.  It is always a tuple of length 4.
-    #: It has the same RGB values as edge_color_, and its alpha value is the
-    #: alpha value of self.edge_color multiplied by self.alpha.
+
+    #: The RGBA tuple for rendering edges. It is always a tuple of length 4.
+    #: It has the same RGB values as :attr:`edge_color`, and its alpha value
+    #: is the alpha value of self.edge_color multiplied by self.alpha.
     effective_edge_color = Property(Tuple, depends_on=['edge_color', 'alpha'])
-    
-    #: The RGBA tuple for rendering the face.  It is always a tuple of length 4.
-    #: It has the same RGB values as face_color_, and its alpha value is the
-    #: alpha value of self.face_color multiplied by self.alpha.
+
+    #: The RGBA tuple for rendering the face. It is always a tuple of length
+    #: 4. It has the same RGB values as :attr:`face_color`, and its alpha
+    #: value is the alpha value of self.face_color multiplied by self.alpha.
     effective_face_color = Property(Tuple, depends_on=['face_color', 'alpha'])
 
     #----------------------------------------------------------------------

chaco/toolbar_plot.py

@@ -13,10 +13,9 @@ class ToolbarPlot(Plot):
     toolbar_added = False
 
     #: Location of the default toolbar that is created if a toolbar
-    #: is not specified with the `toolbar` attribute.  Changing this
+    #: is not specified with the :attr:`toolbar` attribute.  Changing this
     #: attribute after the ToolbarPlot instance is created has no effect;
-    #: use obj.toolbar.location to dynamically change the location of the
-    #: instance `obj`s toolbar.
+    #: use obj.toolbar.location to dynamically change toolbar's location.
     toolbar_location = Enum('top', 'right', 'bottom', 'left')
 
     def __init__(self, *args, **kw):

examples/demo/depth.py

@@ -1,3 +1,7 @@
+"""
+Plot where depth is the index such that the plot is vertical and the origin is 
+the upper left
+"""
 import numpy
 from chaco.api import ToolbarPlot, ArrayPlotData
 from chaco.tools.api import LineInspector

examples/demo/domain_limits.py

@@ -1,3 +1,8 @@
+"""
+Domain Limits
+=============
+"""
+
 import numpy
 
 from chaco.plot import Plot, ArrayPlotData

examples/demo/multi_line_plot.py

@@ -1,3 +1,7 @@
+""" Displays a plot with a few buttons to control which overlay
+    to display
+"""
+
 import numpy as np
 
 from chaco.api import LinearMapper, Plot, ArrayDataSource, DataRange1D

examples/demo/multi_line_plot_demo.py

@@ -1,3 +1,10 @@
+"""
+Demonstrates the MultiLinePlot.
+
+This demo assumes that 'model', an instance of DataModel containing the 2D
+data to be plotted, will be given to the constructor, and will not change
+later.
+"""
 import numpy as np
 
 from traits.api import Instance, HasTraits, Range, Array
@@ -24,12 +31,6 @@ class DataModel(HasTraits):
 
 
 class MultiLinePlotDemo(HasTraits):
-    """Demonstrates the MultiLinePlot.
-
-    This demo assumes that 'model', an instance of DataModel containing the 2D
-    data to be plotted, will be given to the constructor, and will not change
-    later.
-    """
 
     model = Instance(DataModel)
 

examples/demo/status_overlay.py

@@ -1,4 +1,6 @@
-
+"""
+Displays a plot with a few buttons to control which overlay to display
+"""
 import numpy
 
 from chaco.api import Plot, ArrayPlotData

examples/demo/vtk_example.py

@@ -1,3 +1,6 @@
+"""
+VTK Example
+"""
 
 from numpy import linspace
 from scipy.special import jn