SF.net SVN: matplotlib: [5348] trunk/matplotlib/doc/users/mathtext.rst

2008-06-01 Thread dsdale
Revision: 5348
  http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5348&view=rev
Author:   dsdale
Date: 2008-06-01 04:07:42 -0700 (Sun, 01 Jun 2008)

Log Message:
---
mask a section on STIX fonts in mathtext.rst which is causing
latex document compilation problems.

Modified Paths:
--
trunk/matplotlib/doc/users/mathtext.rst

Modified: trunk/matplotlib/doc/users/mathtext.rst
===
--- trunk/matplotlib/doc/users/mathtext.rst 2008-06-01 11:03:32 UTC (rev 
5347)
+++ trunk/matplotlib/doc/users/mathtext.rst 2008-06-01 11:07:42 UTC (rev 
5348)
@@ -156,17 +156,17 @@
 ``\mathcal``:math:`\mathcal{CALLIGRAPHY}`
 === =
 
-When using the STIX fonts, you also have the choice of:
+.. When using the STIX fonts, you also have the choice of:
+..
+.. =
+..Command  Result
+.. =
+..``\mathbb``  :math:`\mathbb{Blackboard}`
+..``\mathcircled`` :math:`\mathcircled{Circled}`
+..``\mathfrak``:math:`\mathfrak{Fraktur}`
+..``\mathsf``  :math:`\mathsf{sans-serif}`
+.. =
 
- =
-Command  Result
- =
-``\mathbb``  :math:`\mathbb{Blackboard}`
-``\mathcircled`` :math:`\mathcircled{Circled}`
-``\mathfrak``:math:`\mathfrak{Fraktur}`
-``\mathsf``  :math:`\mathsf{sans-serif}`
- =
-
 Accents
 ---
 


This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.

-
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse012070mrt/direct/01/
___
Matplotlib-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins


SF.net SVN: matplotlib: [5347] trunk/matplotlib/doc/api/pyplot_api.rst

2008-06-01 Thread dsdale
Revision: 5347
  http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5347&view=rev
Author:   dsdale
Date: 2008-06-01 04:03:32 -0700 (Sun, 01 Jun 2008)

Log Message:
---
continued docstring work

Modified Paths:
--
trunk/matplotlib/doc/api/pyplot_api.rst

Modified: trunk/matplotlib/doc/api/pyplot_api.rst
===
--- trunk/matplotlib/doc/api/pyplot_api.rst 2008-06-01 00:41:54 UTC (rev 
5346)
+++ trunk/matplotlib/doc/api/pyplot_api.rst 2008-06-01 11:03:32 UTC (rev 
5347)
@@ -6,4 +6,4 @@
 =
 
 .. automodule:: matplotlib.pyplot
-   :members:
\ No newline at end of file
+   :members: acorr
\ No newline at end of file


This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.

-
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse012070mrt/direct/01/
___
Matplotlib-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins


SF.net SVN: matplotlib: [5349] trunk/matplotlib

2008-06-01 Thread dsdale
Revision: 5349
  http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5349&view=rev
Author:   dsdale
Date: 2008-06-01 06:15:36 -0700 (Sun, 01 Jun 2008)

Log Message:
---
do not use column- or row-spanning cells in rest tables.
Such tables can not be converted to latex by sphinx.

Modified Paths:
--
trunk/matplotlib/doc/api/pyplot_api.rst
trunk/matplotlib/doc/devel/documenting_mpl.rst
trunk/matplotlib/lib/matplotlib/axes.py
trunk/matplotlib/lib/matplotlib/contour.py
trunk/matplotlib/lib/matplotlib/lines.py
trunk/matplotlib/lib/matplotlib/pyplot.py

Modified: trunk/matplotlib/doc/api/pyplot_api.rst
===
--- trunk/matplotlib/doc/api/pyplot_api.rst 2008-06-01 11:07:42 UTC (rev 
5348)
+++ trunk/matplotlib/doc/api/pyplot_api.rst 2008-06-01 13:15:36 UTC (rev 
5349)
@@ -2,8 +2,9 @@
 matplotlib pyplot
 *
 
+
 :mod:`matplotlib.pyplot`
 =
 
 .. automodule:: matplotlib.pyplot
-   :members: acorr
\ No newline at end of file
+   :members:
\ No newline at end of file

Modified: trunk/matplotlib/doc/devel/documenting_mpl.rst
===
--- trunk/matplotlib/doc/devel/documenting_mpl.rst  2008-06-01 11:07:42 UTC 
(rev 5348)
+++ trunk/matplotlib/doc/devel/documenting_mpl.rst  2008-06-01 13:15:36 UTC 
(rev 5349)
@@ -30,6 +30,9 @@
 statement. For example, in the Developers Guide, index.rst lists
 coding_guide, which automatically inserts coding_guide.rst.
 
+Sphinx does not support tables with column- or row-spanning cells for
+latex output. Such tables can not be used when documenting matplotlib.
+
 Mathematical expressions can be rendered as png images in html, and in
 the usual way by latex. For example:
 

Modified: trunk/matplotlib/lib/matplotlib/axes.py
===
--- trunk/matplotlib/lib/matplotlib/axes.py 2008-06-01 11:07:42 UTC (rev 
5348)
+++ trunk/matplotlib/lib/matplotlib/axes.py 2008-06-01 13:15:36 UTC (rev 
5349)
@@ -3888,7 +3888,7 @@
 call signature::
 
   errorbar(x, y, yerr=None, xerr=None,
-   fmt='b-', ecolor=None, elinewidth=None, capsize=3,
+   fmt='-', ecolor=None, elinewidth=None, capsize=3,
barsabove=False, lolims=False, uplims=False,
xlolims=False, xuplims=False)
 
@@ -3901,39 +3901,31 @@
 
 Optional keyword arguments:
 
-  ++--+
-  | Keyword| Description  |
-  ++==+
-  | xerr   | a rank-0 or Nx1 Numpy array yields symmetric |
-  | yerr   | errorbars +/- value  |
-  |+--+
-  || an N-element list or tuple yields symmetric  |
-  || errorbars +/- value  |
-  |+--+
-  || a rank-1, Nx2 Numpy array yields asymmetric  |
-  || errorbars: -column1/+column2 |
-  ++--+
-  | fmt| the plot format symbol for y. If fmt is None, just   |
-  || plot the errorbars with no line symbols.  This can   |
-  || be useful for creating a bar plot with errorbars |
-  ++--+
-  | ecolor | a matplotlib color arg which gives the color the |
-  || errorbar lines; if None, use the marker color.   |
-  ++--+
-  | elinewidth | the linewidth of the errorbar lines. If None, use|
-  || the linewidth.   |
-  ++--+
-  | capsize| the size of the error bar caps in points |
-  ++--+
-  | barsabove  | if True, will plot the errorbars above the plot  |
-  || symbols. Default is below.   |
-  ++--+
-  | lolims | These arguments can be used to indicate that a value |
-  | uplims | gives only upper/lower limits. In that case a caret  |
-  | xlolims| symbol is used to indicate this. lims-arguments may  |
-   

SF.net SVN: matplotlib: [5350] trunk/matplotlib/lib/matplotlib

2008-06-01 Thread dsdale
Revision: 5350
  http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5350&view=rev
Author:   dsdale
Date: 2008-06-01 08:37:48 -0700 (Sun, 01 Jun 2008)

Log Message:
---
continued docstring conversion

Modified Paths:
--
trunk/matplotlib/lib/matplotlib/axes.py
trunk/matplotlib/lib/matplotlib/pyplot.py

Modified: trunk/matplotlib/lib/matplotlib/axes.py
===
--- trunk/matplotlib/lib/matplotlib/axes.py 2008-06-01 13:15:36 UTC (rev 
5349)
+++ trunk/matplotlib/lib/matplotlib/axes.py 2008-06-01 15:37:48 UTC (rev 
5350)
@@ -2995,27 +2995,24 @@
 
 def loglog(self, *args, **kwargs):
 """
-LOGLOG(*args, **kwargs)
+call signature::
 
-Make a loglog plot with log scaling on the a and y axis.  The args
-to semilog x are the same as the args to plot.  See help plot for
-more info.
+  loglog(*args, **kwargs)
 
-Optional keyword args supported are any of the kwargs
-supported by plot or set_xscale or set_yscale.  Notable, for
-log scaling:
+Make a plot with log scaling on the a and y axis. The args to loglog
+are the same as the args to ``plot``.  See ``plot`` for more info.
 
-  * basex: base of the x logarithm
+loglog supports all the keyword arguments of ``plot`` and
+Axes.set_xscale/Axes.set_yscale.
 
-  * subsx: the location of the minor ticks; None defaults to
-autosubs, which depend on the number of decades in the
-plot; see set_xscale for details
+Notable keyword arguments:
 
-  * basey: base of the y logarithm
-
-  * subsy: the location of the minor yticks; None defaults to
+  basex/basey: scalar > 1
+base of the x/y logarithm
+  subsx/subsy: [ None | sequence ]
+the location of the minor x/yticks; None defaults to
 autosubs, which depend on the number of decades in the
-plot; see set_yscale for details
+plot; see set_xscale/set_yscale for details
 
 The remaining valid kwargs are Line2D properties:
 %(Line2D)s
@@ -3214,68 +3211,92 @@
 
 def legend(self, *args, **kwargs):
 """
-LEGEND(*args, **kwargs)
+call signature::
 
+  legend(*args, **kwargs)
+
 Place a legend on the current axes at location loc.  Labels are a
 sequence of strings and loc can be a string or an integer specifying
 the legend location
 
-USAGE:
+To make a legend with existing lines::
 
-  Make a legend with existing lines
+  legend()
 
-  >>> legend()
+legend by itself will try and build a legend using the label
+property of the lines/patches/collections.  You can set the label of
+a line by doing plot(x, y, label='my data') or line.set_label('my
+data'). If label is set to '_nolegend_', the item will not be shown
+in legend.
 
-  legend by itself will try and build a legend using the label
-  property of the lines/patches/collections.  You can set the label of
-  a line by doing plot(x, y, label='my data') or line.set_label('my
-  data'). If label is set to '_nolegend_', the item will not be shown
-  in legend.
+To automatically generate the legend from labels::
 
-# automatically generate the legend from labels
-legend( ('label1', 'label2', 'label3') )
+  legend( ('label1', 'label2', 'label3') )
 
-# Make a legend for a list of lines and labels
-legend( (line1, line2, line3), ('label1', 'label2', 'label3') )
+To make a legend for a list of lines and labels::
 
-# Make a legend at a given location, using a location argument
-# legend( LABELS, LOC )  or
-# legend( LINES, LABELS, LOC )
-legend( ('label1', 'label2', 'label3'), loc='upper left')
-legend( (line1, line2, line3),  ('label1', 'label2', 'label3'), 
loc=2)
+  legend( (line1, line2, line3), ('label1', 'label2', 'label3') )
 
+To make a legend at a given location, using a location argument::
+
+  legend( ('label1', 'label2', 'label3'), loc='upper left')
+
+or::
+
+  legend( (line1, line2, line3),  ('label1', 'label2', 'label3'), 
loc=2)
+
 The location codes are
 
-  'best' : 0,
-  'upper right'  : 1,
-  'upper left'   : 2,
-  'lower left'   : 3,
-  'lower right'  : 4,
-  'right': 5,
-  'center left'  : 6,
-  'center right' : 7,
-  'lower center' : 8,
-  'upper center' : 9,
-  'center'   : 10,
+  ===   =
+  Location String   Location Code
+  ===   =
+  'best'0
+