* Remove matplotlib.legend from artist_api.rst since it is document in legend_api

jdh2358 · jdh2358 · commit 2b7ce9ed8000 · 2011-09-29T15:05:26.000-05:00
* Fix pyplot docstring :module: -&gt; :mod to remove error: Unknown interpreted text role "module".

* Fix pyplot tight_layout docstring to get rid of 'Unexpected section title.' error

* reformatted docstring in tight_layout.auto_adjust_subplotpars

* fix what's new bullet list ends w/o blank line issues

* remove plotting.rst and arraydata.rst stub docs

* Added environment_variables.rst to FAQ index

* removed normed warning on Axes.hist

* fix an nxutils.point_inside_poly docstring definition list bug
diff --git a/doc/api/artist_api.rst b/doc/api/artist_api.rst
@@ -15,13 +15,6 @@ artists
    :undoc-members:
    :show-inheritance:
 
-:mod:`matplotlib.legend`
-=============================
-
-.. automodule:: matplotlib.legend
-   :members:
-   :undoc-members:
-   :show-inheritance:
 
 :mod:`matplotlib.lines`
 =============================
diff --git a/doc/faq/index.rst b/doc/faq/index.rst
@@ -18,3 +18,5 @@ The Matplotlib FAQ
    usage_faq.rst
    howto_faq.rst
    troubleshooting_faq.rst
+   environment_variables_faq.rst
+
diff --git a/doc/matplotlibrc b/doc/matplotlibrc
@@ -13,3 +13,4 @@ docstring.hardcopy : True  # set this when you want to generate hardcopy docstri
 
 #examples.download : False  # False to bypass downloading mechanism
 #examples.directory : /your/path/to/sample_data/   # directory to look in if download is false
+
diff --git a/doc/users/arraydata.rst b/doc/users/arraydata.rst
diff --git a/doc/users/plotting.rst b/doc/users/plotting.rst
diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst
@@ -133,10 +133,12 @@ as 2D plotting, Ben Root has made several improvements to the
 * Most 3D plotting functions now support empty inputs
 
 * Ticker offset display added:
+
 .. plot:: mpl_examples/mplot3d/offset_demo.py
 
 * :meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.contourf`
   gains *zdir* and *offset* kwargs. You can now do this:
+
 .. plot:: mpl_examples/mplot3d/contourf3d_demo2.py
 
 Numerix support removed
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -2067,7 +2067,7 @@ def grid(self, b=None, which='major', axis='both', **kwargs):
         *axis* can be 'both' (default), 'x', or 'y' to control which
         set of gridlines are drawn.
 
-        *kawrgs* are used to set the grid line properties, eg::
+        *kwargs* are used to set the grid line properties, eg::
 
            ax.grid(color='r', linestyle='-', linewidth=2)
 
@@ -7662,16 +7662,6 @@ def hist(x, bins=10, range=None, normed=False, weights=None,
                 db = np.diff(bins)
                 m = (m.astype(float) / db) / m.sum()
             n.append(m)
-        if normed and db.std() > 0.01 * db.mean():
-            warnings.warn("""
-            This release fixes a normalization bug in the NumPy histogram
-            function prior to version 1.5, occuring with non-uniform
-            bin widths. The returned and plotted value is now a density:
-                n / (N * bin width),
-            where n is the bin count and N the total number of points.
-            """)
-
-
 
         if cumulative:
             slc = slice(None)
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1310,10 +1310,11 @@ def get_tightbbox(self, renderer):
 
 
     def tight_layout(self, renderer=None, pad=1.2, h_pad=None, w_pad=None):
-        """Adjust subplot parameters to give specified padding.
+        """
+        Adjust subplot parameters to give specified padding.
+
+        Parameters:
 
-        Parameters
-        ----------
         pad : float
             padding between the figure edge and the edges of subplots, as a fraction of the font-size.
         h_pad, w_pad : float
diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -268,10 +268,11 @@ def locally_modified_subplot_params(self):
 
 
     def tight_layout(self, fig, renderer=None, pad=1.2, h_pad=None, w_pad=None, rect=None):
-        """Adjust subplot parameters to give specified padding.
+        """
+        Adjust subplot parameters to give specified padding.
 
-        Parameters
-        ----------
+        Parameters:
+        
         pad : float
             padding between the figure edge and the edges of subplots, as a fraction of the font-size.
         h_pad, w_pad : float
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -457,7 +457,7 @@ def draw():
 
     A more object-oriented alternative, given any
     :class:`~matplotlib.figure.Figure` instance, :attr:`fig`, that
-    was created using a :module:`~matplotlib.pyplot` function, is::
+    was created using a :mod:`~matplotlib.pyplot` function, is::
 
         fig.canvas.draw()
 
@@ -1035,10 +1035,11 @@ def subplot_tool(targetfig=None):
 
 
 def tight_layout(pad=1.2, h_pad=None, w_pad=None):
-    """Adjust subplot parameters to give specified padding.
+    """
+    Adjust subplot parameters to give specified padding.
+
+    Parameters:
 
-    Parameters
-    ----------
     pad : float
         padding between the figure edge and the edges of subplots, as a fraction of the font-size.
     h_pad, w_pad : float
diff --git a/lib/matplotlib/tight_layout.py b/lib/matplotlib/tight_layout.py
@@ -42,20 +42,28 @@ def auto_adjust_subplotpars(fig, renderer,
     Return a dictionary of subplot parameters so that spacing between
     subplots are adjusted. Note that this function ignore geometry
     information of subplot itself, but uses what is given by
-    nrows_ncols and num1num2_list parameteres. Also, the results could be
-    incorrect if some subplots have adjustable=datalim.
+    *nrows_ncols* and *num1num2_list* parameteres. Also, the results could be
+    incorrect if some subplots have ``adjustable=datalim``.
     
-    Parameters
-    ----------
-    nrows_ncols : number of rows and number of columns of the grid.
-    num1num2_list : list of numbers specifying the area occupied by the subplot
-    subplot_list : list of subplots that will be used to calcuate optimal subplot_params.
+    Parameters:
+
+    nrows_ncols
+      number of rows and number of columns of the grid.
+
+    num1num2_list
+      list of numbers specifying the area occupied by the subplot
+
+    subplot_list
+      list of subplots that will be used to calcuate optimal subplot_params.
+
     pad : float
-        padding between the figure edge and the edges of subplots, as a fraction of the font-size.
+      padding between the figure edge and the edges of subplots, as a fraction of the font-size.
     h_pad, w_pad : float
-        padding (height/width) between edges of adjacent subplots.
+      padding (height/width) between edges of adjacent subplots.
         Defaults to `pad_inches`.
-    rect : [left, bottom, right, top] in normalized (0, 1) figure coordinates.
+
+    rect
+      [left, bottom, right, top] in normalized (0, 1) figure coordinates.
     """
 
 
diff --git a/src/nxutils.c b/src/nxutils.c
@@ -231,7 +231,7 @@ static PyMethodDef module_methods[] = {
         "Return a boolean ndarray, True for points inside the polygon.\n\n"
         "*xypoints*\n    a sequence of N x,y pairs.\n"
         "*xyverts*\n    sequence of x,y vertices of the polygon.\n"
-        "*mask*    an ndarray of length N.\n\n"
+        "*mask*\n   an ndarray of length N.\n\n"
         "A point on the boundary may be treated as inside or outside.\n"
         "See `pnpoly <http://www.ecse.rpi.edu/Homepages/wrf/Research/Short_Notes/pnpoly.html>`_\n"},
   {NULL}  /* Sentinel */

Original file line number	Diff line number	Diff line change
`@@ -13,3 +13,4 @@ docstring.hardcopy : True # set this when you want to generate hardcopy docstri`
`13`	`13`
`14`	`14`	`#examples.download : False # False to bypass downloading mechanism`
`15`	`15`	`#examples.directory : /your/path/to/sample_data/ # directory to look in if download is false`
	`16`	`+`