Menu
▾
▴
SF.net SVN: matplotlib:[5978] trunk/htdocs
|
From: <jd...@us...> - 2008-08-06 00:28:16
|
Revision: 5978
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5978&view=rev
Author: jdh2358
Date: 2008-08-06 00:28:03 +0000 (Wed, 06 Aug 2008)
Log Message:
-----------
updated docs for 98.3
Modified Paths:
--------------
trunk/htdocs/API_CHANGES
trunk/htdocs/CHANGELOG
trunk/htdocs/convert.py
trunk/htdocs/credits.html.template
trunk/htdocs/faq.html.template
trunk/htdocs/license.html.template
trunk/htdocs/make.py
trunk/htdocs/matplotlib.afm.html.template
trunk/htdocs/matplotlib.artist.html.template
trunk/htdocs/matplotlib.axes.html.template
trunk/htdocs/matplotlib.axis.html.template
trunk/htdocs/matplotlib.backend_bases.html.template
trunk/htdocs/matplotlib.backends.backend_agg.html.template
trunk/htdocs/matplotlib.backends.backend_cairo.html.template
trunk/htdocs/matplotlib.backends.backend_gtk.html.template
trunk/htdocs/matplotlib.backends.backend_gtkagg.html.template
trunk/htdocs/matplotlib.backends.backend_gtkcairo.html.template
trunk/htdocs/matplotlib.backends.backend_ps.html.template
trunk/htdocs/matplotlib.backends.backend_qt.html.template
trunk/htdocs/matplotlib.backends.backend_qtagg.html.template
trunk/htdocs/matplotlib.backends.backend_svg.html.template
trunk/htdocs/matplotlib.backends.backend_template.html.template
trunk/htdocs/matplotlib.backends.backend_tkagg.html.template
trunk/htdocs/matplotlib.backends.backend_wx.html.template
trunk/htdocs/matplotlib.backends.backend_wxagg.html.template
trunk/htdocs/matplotlib.cbook.html.template
trunk/htdocs/matplotlib.cm.html.template
trunk/htdocs/matplotlib.collections.html.template
trunk/htdocs/matplotlib.colorbar.html.template
trunk/htdocs/matplotlib.colors.html.template
trunk/htdocs/matplotlib.contour.html.template
trunk/htdocs/matplotlib.dates.html.template
trunk/htdocs/matplotlib.figure.html.template
trunk/htdocs/matplotlib.finance.html.template
trunk/htdocs/matplotlib.font_manager.html.template
trunk/htdocs/matplotlib.image.html.template
trunk/htdocs/matplotlib.legend.html.template
trunk/htdocs/matplotlib.lines.html.template
trunk/htdocs/matplotlib.mathtext.html
trunk/htdocs/matplotlib.mathtext.html.template
trunk/htdocs/matplotlib.mlab.html.template
trunk/htdocs/matplotlib.numerix.html.template
trunk/htdocs/matplotlib.patches.html.template
trunk/htdocs/matplotlib.pylab.html.template
trunk/htdocs/matplotlib.pyplot.html.template
trunk/htdocs/matplotlib.quiver.html.template
trunk/htdocs/matplotlib.rcsetup.html.template
trunk/htdocs/matplotlib.table.html.template
trunk/htdocs/matplotlib.texmanager.html.template
trunk/htdocs/matplotlib.text.html.template
trunk/htdocs/matplotlib.ticker.html.template
trunk/htdocs/matplotlib.transforms.html.template
trunk/htdocs/matplotlib.units.html.template
trunk/htdocs/matplotlib.widgets.html.template
trunk/htdocs/matplotlibrc
trunk/htdocs/screenshots.html.template
trunk/htdocs/tut/custom_axes.png
trunk/htdocs/tut/mathtext_tut.png
trunk/htdocs/tut/text_simple.png
trunk/htdocs/tutorial.html.template
trunk/htdocs/whats_new.html.template
Modified: trunk/htdocs/API_CHANGES
===================================================================
--- trunk/htdocs/API_CHANGES 2008-08-05 19:32:44 UTC (rev 5977)
+++ trunk/htdocs/API_CHANGES 2008-08-06 00:28:03 UTC (rev 5978)
@@ -1,4 +1,33 @@
+Changes for 0.98.x
+==================
+
+* Deprecated (raise NotImplementedError) all the mlab2 functions from
+ matplotlib.mlab out of concern that some of them were not clean room
+ implementations.
+
+* Methods get_offsets and set_offsets added to Collections base
+ class.
+
+* Figure.figurePatch renamed Figure.patch, Axes.axesPatch renamed
+ Axes.patch, Axes.axesFrame renamed Axes.frame, Axes.get_frame, which
+ returns Axes.patch, is deprecated. Examples and users guide updated
+
+* Changes in the ContourLabeler attributes (clabel function) so that they
+ all have a form like .labelAttribute. The three attributes that are most
+ likely to be used by end users, .cl, .cl_xy and .cl_cvalues have been
+ maintained for the moment (in addition to their renamed versions), but they
+ are depricated and will eventually be removed.
+
+Changes for 0.98.1
+==================
+
+* Removed broken axes3d support and replaced it with a non implemented
+ error pointing to 0.91.x
+
+Changes for 0.98.0
+==================
+
matplotlib.image.imread now no longer always returns RGBA -- if
the image is luminance or RGB, it will return a MxN or MxNx3 array
if possible. Also uint8 is no longer always forced to float.
@@ -40,6 +69,11 @@
See transforms.py for a description of the design of the new
transformation framework.
+ For efficiency, many of these functions return views into Numpy
+ arrays. This means that if you hold on to a reference to them,
+ their contents may change. If you want to store a snapshot of
+ their current values, use the Numpy array method copy().
+
The view intervals are now stored only in one place -- in the Axes
instance, not in the formatter instances as well. This means
formatters must get their limits from their Axis, which in turn
Modified: trunk/htdocs/CHANGELOG
===================================================================
--- trunk/htdocs/CHANGELOG 2008-08-05 19:32:44 UTC (rev 5977)
+++ trunk/htdocs/CHANGELOG 2008-08-06 00:28:03 UTC (rev 5978)
@@ -1,4 +1,205 @@
+=================================================================
+2008-08-03 Released 0.98.3 at svn r5947
+
+2008-08-01 Backported memory leak fixes in _ttconv.cpp - MGD
+
+2008-07-31 Added masked array support to griddata. - JSW
+
+2008-07-26 Added optional C and reduce_C_function arguments to
+ axes.hexbin(). This allows hexbin to accumulate the values
+ of C based on the x,y coordinates and display in hexagonal
+ bins. - ADS
+
+2008-07-24 Deprecated (raise NotImplementedError) all the mlab2
+ functions from matplotlib.mlab out of concern that some of
+ them were not clean room implementations. JDH
+
+2008-07-24 Rewrite of a significant portion of the clabel code (class
+ ContourLabeler) to improve inlining. - DMK
+
+2008-07-22 Added Barbs polygon collection (similar to Quiver) for plotting
+ wind barbs. Added corresponding helpers to Axes and pyplot as
+ well. (examples/pylab_examples/barb_demo.py shows it off.) - RMM
+
+2008-07-21 Added scikits.delaunay as matplotlib.delaunay. Added griddata
+ function in matplotlib.mlab, with example (griddata_demo.py) in
+ pylab_examples. griddata function will use mpl_toolkits._natgrid
+ if installed. - JSW
+
+2008-07-21 Re-introduced offset_copy that works in the context of the
+ new transforms. - MGD
+
+2008-07-21 Committed patch by Ryan May to add get_offsets and
+ set_offsets to Collections base class - EF
+
+2008-07-21 Changed the "asarray" strategy in image.py so that
+ colormapping of masked input should work for all
+ image types (thanks Klaus Zimmerman) - EF
+
+2008-07-20 Rewrote cbook.delete_masked_points and corresponding
+ unit test to support rgb color array inputs, datetime
+ inputs, etc. - EF
+
+2008-07-20 Renamed unit/axes_unit.py to cbook_unit.py and modified
+ in accord with Ryan's move of delete_masked_points from
+ axes to cbook. - EF
+
+2008-07-18 Check for nan and inf in axes.delete_masked_points().
+ This should help hexbin and scatter deal with nans. - ADS
+
+2008-07-17 Added ability to manually select contour label locations.
+ Also added a waitforbuttonpress function. - DMK
+
+2008-07-17 Fix bug with NaNs at end of path (thanks, Andrew Straw for
+ the report) - MGD
+
+2008-07-16 Improve error handling in texmanager, thanks to Ian Henry
+ for reporting - DSD
+
+2008-07-12 Added support for external backends with the
+ "module://my_backend" syntax - JDH
+
+2008-07-11 Fix memory leak related to shared axes. Grouper should
+ store weak references. - MGD
+
+2008-07-10 Bugfix: crash displaying fontconfig pattern - MGD
+
+2008-07-10 Bugfix: [ 2013963 ] update_datalim_bounds in Axes not works - MGD
+
+2008-07-10 Bugfix: [ 2014183 ] multiple imshow() causes gray edges - MGD
+
+2008-07-09 Fix rectangular axes patch on polar plots bug - MGD
+
+2008-07-09 Improve mathtext radical rendering - MGD
+
+2008-07-08 Improve mathtext superscript placement - MGD
+
+2008-07-07 Fix custom scales in pcolormesh (thanks Matthew Turk) - MGD
+
+2008-07-03 Implemented findobj method for artist and pyplot - see
+ examples/pylab_examples/findobj_demo.py - JDH
+
+2008-06-30 Another attempt to fix TextWithDash - DSD
+
+2008-06-30 Removed Qt4 NavigationToolbar2.destroy -- it appears to
+ have been unnecessary and caused a bug reported by P.
+ Raybaut - DSD
+
+2008-06-27 Fixed tick positioning bug - MM
+
+2008-06-27 Fix dashed text bug where text was at the wrong end of the
+ dash - MGD
+
+2008-06-26 Fix mathtext bug for expressions like $x_{\leftarrow}$ - MGD
+
+2008-06-26 Fix direction of horizontal/vertical hatches - MGD
+
+2008-06-25 Figure.figurePatch renamed Figure.patch, Axes.axesPatch
+ renamed Axes.patch, Axes.axesFrame renamed Axes.frame,
+ Axes.get_frame, which returns Axes.patch, is deprecated.
+ Examples and users guide updated - JDH
+
+2008-06-25 Fix rendering quality of pcolor - MGD
+
+=================================================================
+2008-06-24 Released 0.98.2 at svn r5667 - (source only for debian) JDH
+
+2008-06-24 Added "transparent" kwarg to savefig. - MGD
+
+2008-06-24 Applied Stefan's patch to draw a single centered marker over
+ a line with numpoints==1 - JDH
+
+2008-06-23 Use splines to render circles in scatter plots - MGD
+
===============================================================
+2008-06-22 Released 0.98.1 at revision 5637
+
+2008-06-22 Removed axes3d support and replaced it with a
+ NotImplementedError for one release cycle
+
+2008-06-21 fix marker placement bug in backend_ps - DSD
+
+2008-06-20 [ 1978629 ] scale documentation missing/incorrect for log - MGD
+
+2008-06-20 Added closed kwarg to PolyCollection. Fixes bug [ 1994535
+ ] still missing lines on graph with svn (r 5548). - MGD
+
+2008-06-20 Added set/get_closed method to Polygon; fixes error
+ in hist - MM
+
+2008-06-19 Use relative font sizes (e.g. 'medium' and 'large') in
+ rcsetup.py and matplotlibrc.template so that text will
+ be scaled by default when changing rcParams['font.size'] -
+ EF
+
+2008-06-17 Add a generic PatchCollection class that can contain any
+ kind of patch. - MGD
+
+2008-06-13 Change pie chart label alignment to avoid having labels
+ overwrite the pie - MGD
+
+2008-06-12 Added some helper functions to the mathtext parser to
+ return bitmap arrays or write pngs to make it easier to use
+ mathtext outside the context of an mpl figure. modified
+ the mathpng sphinxext to use the mathtext png save
+ functionality - see examples/api/mathtext_asarray.py - JDH
+
+2008-06-11 Use matplotlib.mathtext to render math expressions in
+ online docs - MGD
+
+2008-06-11 Move PNG loading/saving to its own extension module, and
+ remove duplicate code in _backend_agg.cpp and _image.cpp
+ that does the same thing - MGD
+
+2008-06-11 Numerous mathtext bugfixes, primarily related to
+ dpi-independence - MGD
+
+2008-06-10 Bar now applies the label only to the first patch only, and
+ sets '_nolegend_' for the other patch labels. This lets
+ autolegend work as expected for hist and bar - see
+ https://sourceforge.net/tracker/index.php?func=detail&aid=1986597&group_id=80706&atid=560720
+ JDH
+
+2008-06-10 Fix text baseline alignment bug. [ 1985420 ] Repair of
+ baseline alignment in Text._get_layout. Thanks Stan West -
+ MGD
+
+2008-06-09 Committed Gregor's image resample patch to downsampling
+ images with new rcparam image.resample - JDH
+
+2008-06-09 Don't install Enthought.Traits along with matplotlib. For
+ matplotlib developers convenience, it can still be
+ installed by setting an option in setup.cfg while we figure
+ decide if there is a future for the traited config - DSD
+
+2008-06-09 Added range keyword arg to hist() - MM
+
+2008-06-07 Moved list of backends to rcsetup.py; made use of lower
+ case for backend names consistent; use validate_backend
+ when importing backends subpackage - EF
+
+2008-06-06 hist() revision, applied ideas proposed by Erik Tollerud and
+ Olle Engdegard: make histtype='step' unfilled by default
+ and introduce histtype='stepfilled'; use default color
+ cycle; introduce reverse cumulative histogram; new align
+ keyword - MM
+
+2008-06-06 Fix closed polygon patch and also provide the option to
+ not close the polygon - MGD
+
+2008-06-05 Fix some dpi-changing-related problems with PolyCollection,
+ as called by Axes.scatter() - MGD
+
+2008-06-05 Fix image drawing so there is no extra space to the right
+ or bottom - MGD
+
+2006-06-04 Added a figure title command subtitle as a Figure method
+ and pyplot command -- see examples/figure_title.py - JDH
+
+2008-06-02 Added support for log to hist with histtype='step' and fixed
+ a bug for log-scale stacked histograms - MM
+
+===============================================================
2008-05-29 Released 0.98.0 at revision 5314
2008-05-29 matplotlib.image.imread now no longer always returns RGBA
Modified: trunk/htdocs/convert.py
===================================================================
--- trunk/htdocs/convert.py 2008-08-05 19:32:44 UTC (rev 5977)
+++ trunk/htdocs/convert.py 2008-08-06 00:28:03 UTC (rev 5978)
@@ -22,7 +22,7 @@
self.body = body
self.title = title
self.bgcolor = bgcolor
-
+
def format_header(self):
return """
<tr><td bgcolor="%s" align="left">
@@ -55,8 +55,8 @@
</font>
</td></tr>
""" % self.header
-
+
def __repr__(self):
s = '<table width=100% border=1 cellpadding=1 ' +\
'cellspacing=1>\n'
@@ -64,14 +64,14 @@
s += ' <tr><td valign="top" bgcolor=#EFEFEF>\n'
for text, link in self.links:
s += ' <a href=%s>%s</a><br>\n' % (link, text)
-
+
s += '</td></tr>\n'
s += '</table>\n'
return s
class FormatGoals:
"""Reads simple text file of goals and formats as html table"""
-
+
def __init__(self, filename):
self.table = []
f = open(filename)
@@ -85,7 +85,7 @@
return None
else:
return self.lines[self.nline].strip()
-
+
def format_table(self):
while 1:
line = self.getline()
@@ -103,7 +103,7 @@
self.table.append("<tr><td colspan=3 bgcolor=#dddddd><b>")
self.table.append(self.getline())
self.table.append("</b></td></tr>")
-
+
elif onlyContains(line, '*'): # Regular table entry
# suck up any intervening blank lines
self.nextline()
@@ -114,8 +114,8 @@
else:
print "WARNING: goals text file is malformed at or around line", \
self.nline
- self.nextline()
-
+ self.nextline()
+
def parse_entry(self):
"""Deal with the different components of a normal goal row"""
ncol = 0
@@ -139,7 +139,7 @@
ncol += 1
if ncol > 2:
ncol = 2
-
+
def addrow(self, cols):
"""Format the entry for a row"""
ncol = 0
@@ -153,15 +153,15 @@
#self.table.append("<font color=#ffffff>.</font>") # need something in cell to format well
self.table.append("</td>")
ncol += 1
- self.table.append("</tr>")
-
+ self.table.append("</tr>")
+
def __repr__(self):
return "\n".join(self.table)
# helper functions for FormatGoals
def onlyContains(line, char):
"""Does line only contain one or more instances of given character?
-
+
(aside from leading or trailing whitespace)"""
tline = line.strip()
@@ -172,14 +172,14 @@
def isComment(line):
return line.strip() and (line.strip()[0] == '#')
-
-def isBlank(line):
+
+def isBlank(line):
return not line.strip()
-
-
+
+
def isNewEntry(line):
- if (onlyContains(line, '=') or
- onlyContains(line, '+') or
+ if (onlyContains(line, '=') or
+ onlyContains(line, '+') or
onlyContains(line, '*')):
return 1
else:
@@ -188,10 +188,11 @@
# re-add news to the params dict 'tables' entry below for news
news1= NewsBox("""matplotlib <a
-href=http://sourceforge.net/project/showfiles.php?group_id=80706&package_id=278194&release_id=603020>0.98.0</a> is a major release which requires python2.4 and numpy 1.1. It contains significant improvements and may require some advanced users to update their code; see <a href=MIGRATION.txt>migration</a> and <a href=API_CHANGES>API_CHANGES</a>. We are supporting a maintenance branch of the older code available at matplotlib <a
-href=http://sourceforge.net/project/showfiles.php?group_id=80706&package_id=82474&release_id=603021>0.91.3</a>""", title='New release')
+href=http://sourceforge.net/project/showfiles.php?group_id=80706&package_id=278194&release_id=617552>0.98.3</a> is a major release which requires python2.4 or 2.5 and numpy 1.1. It contains significant improvements and may require some advanced users to update their code; see <a href=API_CHANGES>API_CHANGES</a>. We are supporting a maintenance branch of the older code available at matplotlib <a
+href=http://sourceforge.net/project/showfiles.php?group_id=80706&package_id=82474&release_id=608756>0.91.4</a>. """, title='New release')
+
news2 = NewsBox("""Help support matplotlib development by <a href=http://sourceforge.net/project/project_donations.php?group_id=80706>donating</a> to fund developer sprints and other matplotlib development costs.""", title='Donate')
@@ -202,19 +203,19 @@
('Download', 'http://sourceforge.net/projects/matplotlib'),
('Installing', 'installing.html'),
('Screenshots', 'screenshots.html'),
- ('Examples (zip)', 'matplotlib_examples_%s.zip'%matplotlib.__version__),
+ ('Examples (zip)', 'matplotlib_examples_%s.zip'%matplotlib.__version__),
('Mailing lists', 'http://sourceforge.net/mail/?group_id=80706'),
- ('Donate', 'http://sourceforge.net/project/project_donations.php?group_id=80706'),
+ ('Donate', 'http://sourceforge.net/project/project_donations.php?group_id=80706'),
))
table2 = LinkBox(header='Documentation', links=(
('Tutorial', 'tutorial.html'),
("User's Guide ", 'users_guide_%s.pdf'%matplotlib.__version__),
('API tutorial', 'pycon/artist_api_tut.pdf'),
- ('Event handling', 'pycon/event_handling_tut.pdf'),
+ ('Event handling', 'pycon/event_handling_tut.pdf'),
("API Reference", 'api.pdf'),
('FAQ', 'faq.html'),
- ('Cookbook / wiki', 'http://www.scipy.org/wikis/topical_software/MatplotlibCookbook'),
+ ('Cookbook / wiki', 'http://www.scipy.org/wikis/topical_software/MatplotlibCookbook'),
('pylab interface', 'pylab_commands.html'),
('Class library', 'classdocs.html'),
('Backends', 'backends.html'),
@@ -233,7 +234,7 @@
params = {
'myemail' : '<a href=mailto:jdh...@ac...> (jdh...@ac...)</a>',
'tables' : (news1, news2, table1, table2, table3),
- 'default_table' : 'border=1 cellpadding=3 cellspacing=2',
+ 'default_table' : 'border=1 cellpadding=3 cellspacing=2',
}
headerBuffer = StringIO()
@@ -249,8 +250,8 @@
params['footer'] = footerBuffer.getvalue()
docs = [modname + '.html.template' for modname in modules]
-
+
files = [
'backends.html.template',
'classdocs.html.template',
@@ -263,15 +264,15 @@
'installing.html.template',
'interactive.html.template',
'license.html.template',
- 'pylab_commands.html.template',
+ 'pylab_commands.html.template',
'screenshots.html.template',
'tutorial.html.template',
- 'whats_new.html.template',
+ 'whats_new.html.template',
]
files.extend(docs)
-
-
+
+
#print params
keysOrig = {}
@@ -307,4 +308,4 @@
print exception_to_str('Failed converting: %s'%inFile)
continue
-
+
Modified: trunk/htdocs/credits.html.template
===================================================================
--- trunk/htdocs/credits.html.template 2008-08-05 19:32:44 UTC (rev 5977)
+++ trunk/htdocs/credits.html.template 2008-08-06 00:28:03 UTC (rev 5978)
@@ -114,7 +114,7 @@
most aspects of matplotlib.</li>
<li>Daishi Harada added support for "Dashed Text". See <a
- href=examples/pylab/dashpointlabel.py>dashpointlabel.py</a> and <a
+ href=examples/pylab_examples/dashpointlabel.py>dashpointlabel.py</a> and <a
href=matplotlib.text.html#TextWithDash>TextWithDash</a></li>
<li>Nicolas Young added support for byte images to imshow, which are
Modified: trunk/htdocs/faq.html.template
===================================================================
--- trunk/htdocs/faq.html.template 2008-08-05 19:32:44 UTC (rev 5977)
+++ trunk/htdocs/faq.html.template 2008-08-06 00:28:03 UTC (rev 5978)
@@ -65,7 +65,7 @@
matplotlib</a> and this <a href=faq.html#FREEZE>faq</a>. So open up a
UNIX shell (or a DOS command prompt) and cd into a directory
containing a minimal example in a file. Something like <a
-href=examples/pylab/simple_plot.py>simple_plot.py</a> or just this
+href=examples/pylab_examples/simple_plot.py>simple_plot.py</a> or just this
<pre>
from pylab import *
@@ -130,7 +130,7 @@
(matplotlib-0.65 or later). The default order is patches, lines,
text, with collections of lines and collections of patches appearing
at the same level as regular lines and patches, respectively. See <a
-href=examples/pylab/zorder_demo.py>zorder_demo.py</a>.
+href=examples/pylab_examples/zorder_demo.py>zorder_demo.py</a>.
"""),
('TOOLBAR2',
@@ -185,7 +185,7 @@
and then the errorbar command will pick a "locator" to handle ticking
and viewport scaling appropriately from the outset. This is the
-approach taken in <a href=examples/pylab/log_bar.py>log_bar.py</a>.
+approach taken in <a href=examples/pylab_examples/log_bar.py>log_bar.py</a>.
"""),
('EQUAL',
@@ -344,12 +344,12 @@
href=http://matplotlib.sf.net/examples>examples</a> subdirectory. If
you are working with date plots you'll find several date demos with
obvious filenames like <a
-href=examples/pylab/date_demo1.py>date_demo1.py</a>. Likewise,
+href=examples/pylab_examples/date_demo1.py>date_demo1.py</a>. Likewise,
you'll find examples for images (<a
-href=examples/pylab/image_demo.py>image_demo.py</a>), contouring
-(<a href=examples/pylab/contour_demo.py>contour_demo.py</a>, using
+href=examples/pylab_examples/image_demo.py>image_demo.py</a>), contouring
+(<a href=examples/pylab_examples/contour_demo.py>contour_demo.py</a>, using
matplotlib with a graphical user interface (<a
-href=examples/pylab/embedding_in_wx.py>examples/user_interfaces/embedding_in_wx.py</a> and
+href=examples/pylab_examples/embedding_in_wx.py>examples/user_interfaces/embedding_in_wx.py</a> and
many more. At last count, there were 116 examples. Because these are
not included with the standard windows installer, they are often
overlooked, which is why I emphasize them here.<p>
@@ -501,7 +501,7 @@
</li>
<li><a
- href=examples/pylab/pythonic_matplotlib.py>pythonic_matplotlib.py</a>
+ href=examples/pylab_examples/pythonic_matplotlib.py>pythonic_matplotlib.py</a>
describes the translation from the matlab style interface to the
pythonic, OO interface.</li>
@@ -584,7 +584,7 @@
linewidth, fontsize, etc, use the <a
href=matplotlib.pyplot.html#-rc>rc</a> command. This changes the
default for the rest of the session, or until you issue another rc
-command. See <a examples/pylab/customize_rc.py>customize_rc.py</a> for
+command. See <a examples/pylab_examples/customize_rc.py>customize_rc.py</a> for
example usage."""),
@@ -639,7 +639,7 @@
'Can I plot data with two y axes scales?',
r"""
As of matplotlib-0.53, there is support for this. See <a
-href=examples/pylab/two_scales.py>two_scales.py</a>.
+href=examples/pylab_examples/two_scales.py>two_scales.py</a>.
"""),
('MATHTEXT',
@@ -789,7 +789,7 @@
For more fine-grained control, you can position axes anywhere you want
in any size using the axes command. See
the <a href=matplotlib.pyplot.html#-axes>axes command</a> and the example
-<a href=examples/pylab/axes_demo.py>axes_demo.py<a/>.<p>
+<a href=examples/pylab_examples/axes_demo.py>axes_demo.py<a/>.<p>
"""),
Modified: trunk/htdocs/license.html.template
===================================================================
--- trunk/htdocs/license.html.template 2008-08-05 19:32:44 UTC (rev 5977)
+++ trunk/htdocs/license.html.template 2008-08-06 00:28:03 UTC (rev 5978)
@@ -6,7 +6,7 @@
<pre>
-LICENSE AGREEMENT FOR MATPLOTLIB 0.98.0
+LICENSE AGREEMENT FOR MATPLOTLIB 0.98.3
--------------------------------------
1. This LICENSE AGREEMENT is between the John D. Hunter ("JDH"), and the
@@ -17,30 +17,30 @@
2. Subject to the terms and conditions of this License Agreement, JDH
hereby grants Licensee a nonexclusive, royalty-free, world-wide license
to reproduce, analyze, test, perform and/or display publicly, prepare
-derivative works, distribute, and otherwise use matplotlib 0.98.0
+derivative works, distribute, and otherwise use matplotlib 0.98.3
alone or in any derivative version, provided, however, that JDH's
License Agreement and JDH's notice of copyright, i.e., "Copyright (c)
2002-2004 John D. Hunter; All Rights Reserved" are retained in
-matplotlib 0.98.0 alone or in any derivative version prepared by
+matplotlib 0.98.3 alone or in any derivative version prepared by
Licensee.
3. In the event Licensee prepares a derivative work that is based on or
-incorporates matplotlib 0.98.0 or any part thereof, and wants to
+incorporates matplotlib 0.98.3 or any part thereof, and wants to
make the derivative work available to others as provided herein, then
Licensee hereby agrees to include in any such work a brief summary of
-the changes made to matplotlib 0.98.0.
+the changes made to matplotlib 0.98.3.
-4. JDH is making matplotlib 0.98.0 available to Licensee on an "AS
+4. JDH is making matplotlib 0.98.3 available to Licensee on an "AS
IS" basis. JDH MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, JDH MAKES NO AND
DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
-FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF MATPLOTLIB 0.98.0
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF MATPLOTLIB 0.98.3
WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.
5. JDH SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF MATPLOTLIB
-0.98.0 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR
+0.98.3 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR
LOSS AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING
-MATPLOTLIB 0.98.0, OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF
+MATPLOTLIB 0.98.3, OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF
THE POSSIBILITY THEREOF.
6. This License Agreement will automatically terminate upon a material
@@ -52,7 +52,7 @@
trademarks or trade name in a trademark sense to endorse or promote
products or services of Licensee, or any third party.
-8. By copying, installing or otherwise using matplotlib 0.98.0,
+8. By copying, installing or otherwise using matplotlib 0.98.3,
Licensee agrees to be bound by the terms and conditions of this License
Agreement.
Modified: trunk/htdocs/make.py
===================================================================
--- trunk/htdocs/make.py 2008-08-05 19:32:44 UTC (rev 5977)
+++ trunk/htdocs/make.py 2008-08-06 00:28:03 UTC (rev 5978)
@@ -29,19 +29,19 @@
print 'Making screenshots'
-#os.system('cd screenshots; python makeshots.py; rm -f _tmp*.py')
+os.system('cd screenshots; python makeshots.py; rm -f _tmp*.py')
print 'Making tutorial images'
-#os.system('cd tut; python runall.py')
+os.system('cd tut; python runall.py')
print 'Running process_docs'
-#os.system('python process_docs.py')
+os.system('python process_docs.py')
print 'Running convert'
os.system('python convert.py')
print 'Building archive'
version = matplotlib.__version__
-tarcommand = 'tar cfz site.tar.gz *.html api.pdf users_guide_%(version)s.pdf matplotlib_examples_%(version)s.zip screenshots tut doc examples matplotlibrc CHANGELOG API_CHANGES MIGRATION.txt set_begone.py logo2.py logo2.png logo_sidebar.png -X exclude.txt'%locals()
+tarcommand = 'tar cfz site.tar.gz *.html api.pdf users_guide_%(version)s.pdf matplotlib_examples_%(version)s.zip screenshots tut doc examples matplotlibrc CHANGELOG API_CHANGES MIGRATION.txt set_begone.py logo2.py logo2.png logo_sidebar.png basemap_readme.txt -X exclude.txt'%locals()
print tarcommand
os.system(tarcommand)
Modified: trunk/htdocs/matplotlib.afm.html.template
===================================================================
--- trunk/htdocs/matplotlib.afm.html.template 2008-08-05 19:32:44 UTC (rev 5977)
+++ trunk/htdocs/matplotlib.afm.html.template 2008-08-06 00:28:03 UTC (rev 5978)
@@ -10,14 +10,14 @@
than mine) I decided not to go with them because either they were<br>
either<br>
<br>
- 1) copyighted or used a non-BSD compatible license<br>
+ 1) copyrighted or used a non-BSD compatible license<br>
<br>
2) had too many dependencies and I wanted a free standing lib<br>
<br>
3) Did more than I needed and it was easier to write my own than<br>
figure out how to just get what I needed from theirs<br>
<br>
-It is pretty easy to use, and requires only built-in python libs<br>
+It is pretty easy to use, and requires only built-in python libs::<br>
<br>
>>> from afm import <a href="#AFM">AFM</a><br>
>>> fh = file('ptmr8a.afm')<br>
@@ -37,7 +37,7 @@
<br>
<br>
AUTHOR:<br>
- John D. Hunter <jdh...@ac...></tt></p>
+ John D. Hunter <jd...@gm...></tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
@@ -65,7 +65,7 @@
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%">Methods defined here:<br>
-<dl><dt><a name="AFM-__init__"><strong>__init__</strong></a>(self, fh)</dt><dd><tt>Parse the <a href="#AFM">AFM</a> file in file object fh</tt></dd></dl>
+<dl><dt><a name="AFM-__init__"><strong>__init__</strong></a>(self, fh)</dt><dd><tt>Parse the <a href="#AFM">AFM</a> file in file object *fh*</tt></dd></dl>
<dl><dt><a name="AFM-get_angle"><strong>get_angle</strong></a>(self)</dt><dd><tt>Return the fontangle as float</tt></dd></dl>
@@ -73,23 +73,23 @@
<dl><dt><a name="AFM-get_capheight"><strong>get_capheight</strong></a>(self)</dt><dd><tt>Return the cap height as float</tt></dd></dl>
-<dl><dt><a name="AFM-get_familyname"><strong>get_familyname</strong></a>(self)</dt><dd><tt>Return the font family name, eg, Times</tt></dd></dl>
+<dl><dt><a name="AFM-get_familyname"><strong>get_familyname</strong></a>(self)</dt><dd><tt>Return the font family name, eg, 'Times'</tt></dd></dl>
-<dl><dt><a name="AFM-get_fontname"><strong>get_fontname</strong></a>(self)</dt><dd><tt>Return the font name, eg, Times-Roman</tt></dd></dl>
+<dl><dt><a name="AFM-get_fontname"><strong>get_fontname</strong></a>(self)</dt><dd><tt>Return the font name, eg, 'Times-Roman'</tt></dd></dl>
-<dl><dt><a name="AFM-get_fullname"><strong>get_fullname</strong></a>(self)</dt><dd><tt>Return the font full name, eg, Times-Roman</tt></dd></dl>
+<dl><dt><a name="AFM-get_fullname"><strong>get_fullname</strong></a>(self)</dt><dd><tt>Return the font full name, eg, 'Times-Roman'</tt></dd></dl>
-<dl><dt><a name="AFM-get_height_char"><strong>get_height_char</strong></a>(self, c, isord<font color="#909090">=False</font>)</dt><dd><tt>Get the height of character c from the bounding box. This is<br>
-the ink height (space is 0)</tt></dd></dl>
+<dl><dt><a name="AFM-get_height_char"><strong>get_height_char</strong></a>(self, c, isord<font color="#909090">=False</font>)</dt><dd><tt>Get the height of character *c* from the bounding box. This<br>
+is the ink height (space is 0)</tt></dd></dl>
-<dl><dt><a name="AFM-get_horizontal_stem_width"><strong>get_horizontal_stem_width</strong></a>(self)</dt><dd><tt>Return the standard horizontal stem width as float, or None if<br>
+<dl><dt><a name="AFM-get_horizontal_stem_width"><strong>get_horizontal_stem_width</strong></a>(self)</dt><dd><tt>Return the standard horizontal stem width as float, or *None* if<br>
not specified in <a href="#AFM">AFM</a> file.</tt></dd></dl>
-<dl><dt><a name="AFM-get_kern_dist"><strong>get_kern_dist</strong></a>(self, c1, c2)</dt><dd><tt>Return the kerning pair distance (possibly 0) for chars c1 and<br>
-c2</tt></dd></dl>
+<dl><dt><a name="AFM-get_kern_dist"><strong>get_kern_dist</strong></a>(self, c1, c2)</dt><dd><tt>Return the kerning pair distance (possibly 0) for chars *c1*<br>
+and *c2*</tt></dd></dl>
-<dl><dt><a name="AFM-get_kern_dist_from_name"><strong>get_kern_dist_from_name</strong></a>(self, name1, name2)</dt><dd><tt>Return the kerning pair distance (possibly 0) for chars c1 and<br>
-c2</tt></dd></dl>
+<dl><dt><a name="AFM-get_kern_dist_from_name"><strong>get_kern_dist_from_name</strong></a>(self, name1, name2)</dt><dd><tt>Return the kerning pair distance (possibly 0) for chars<br>
+*name1* and *name2*</tt></dd></dl>
<dl><dt><a name="AFM-get_name_char"><strong>get_name_char</strong></a>(self, c, isord<font color="#909090">=False</font>)</dt><dd><tt>Get the name of the character, ie, ';' is 'semicolon'</tt></dd></dl>
@@ -99,7 +99,7 @@
<dl><dt><a name="AFM-get_underline_thickness"><strong>get_underline_thickness</strong></a>(self)</dt><dd><tt>Return the underline thickness as float</tt></dd></dl>
-<dl><dt><a name="AFM-get_vertical_stem_width"><strong>get_vertical_stem_width</strong></a>(self)</dt><dd><tt>Return the standard vertical stem width as float, or None if<br>
+<dl><dt><a name="AFM-get_vertical_stem_width"><strong>get_vertical_stem_width</strong></a>(self)</dt><dd><tt>Return the standard vertical stem width as float, or *None* if<br>
not specified in <a href="#AFM">AFM</a> file.</tt></dd></dl>
<dl><dt><a name="AFM-get_weight"><strong>get_weight</strong></a>(self)</dt><dd><tt>Return the font weight, eg, 'Bold' or 'Roman'</tt></dd></dl>
@@ -112,7 +112,7 @@
<dl><dt><a name="AFM-get_xheight"><strong>get_xheight</strong></a>(self)</dt><dd><tt>Return the xheight as float</tt></dd></dl>
<dl><dt><a name="AFM-string_width_height"><strong>string_width_height</strong></a>(self, s)</dt><dd><tt>Return the string width (including kerning) and string height<br>
-as a w,h tuple</tt></dd></dl>
+as a (*w*, *h*) tuple.</tt></dd></dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
@@ -121,13 +121,12 @@
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
-<td width="100%"><dl><dt><a name="-parse_afm"><strong>parse_afm</strong></a>(fh)</dt><dd><tt>Parse the Adobe Font Metics file in file handle fh<br>
-Return value is a (dhead, dcmetrics, dkernpairs, dcomposite) tuple where<br>
- <br>
-dhead : a parse_header dict<br>
-dcmetrics : a parse_composites dict<br>
-dkernpairs : a parse_kern_pairs dict, possibly {}<br>
-dcomposite : a parse_composites dict , possibly {}</tt></dd></dl>
+<td width="100%"><dl><dt><a name="-parse_afm"><strong>parse_afm</strong></a>(fh)</dt><dd><tt>Parse the Adobe Font Metics file in file handle *fh*. Return value<br>
+is a (*dhead*, *dcmetrics*, *dkernpairs*, *dcomposite*) tuple where<br>
+*dhead* is a :func:`_parse_header` dict, *dcmetrics* is a<br>
+:func:`_parse_composites` dict, *dkernpairs* is a<br>
+:func:`_parse_kern_pairs` dict (possibly {}), and *dcomposite* is a<br>
+:func:`_parse_composites` dict (possibly {})</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
Modified: trunk/htdocs/matplotlib.artist.html.template
===================================================================
--- trunk/htdocs/matplotlib.artist.html.template 2008-08-05 19:32:44 UTC (rev 5977)
+++ trunk/htdocs/matplotlib.artist.html.template 2008-08-06 00:28:03 UTC (rev 5978)
@@ -13,9 +13,10 @@
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
-<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="re.html">re</a><br>
+<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="matplotlib.cbook.html">matplotlib.cbook</a><br>
+</td><td width="25%" valign=top><a href="re.html">re</a><br>
</td><td width="25%" valign=top><a href="warnings.html">warnings</a><br>
-</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
+</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
@@ -38,7 +39,8 @@
<font color="#000000" face="helvetica, arial"><a name="Artist">class <strong>Artist</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
-<td colspan=2><tt>Abstract base class for someone who renders into a FigureCanvas<br> </tt></td></tr>
+<td colspan=2><tt>Abstract base class for someone who renders into a<br>
+:class:`FigureCanvas`.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Artist-__init__"><strong>__init__</strong></a>(self)</dt></dl>
@@ -52,19 +54,35 @@
individual artists for details.</tt></dd></dl>
<dl><dt><a name="Artist-convert_xunits"><strong>convert_xunits</strong></a>(self, x)</dt><dd><tt>for artists in an axes, if the xaxis as units support,<br>
-convert x using xaxis unit type</tt></dd></dl>
+convert *x* using xaxis unit type</tt></dd></dl>
<dl><dt><a name="Artist-convert_yunits"><strong>convert_yunits</strong></a>(self, y)</dt><dd><tt>for artists in an axes, if the yaxis as units support,<br>
-convert y using yaxis unit type</tt></dd></dl>
+convert *y* using yaxis unit type</tt></dd></dl>
<dl><dt><a name="Artist-draw"><strong>draw</strong></a>(self, renderer, *args, **kwargs)</dt><dd><tt>Derived classes drawing method</tt></dd></dl>
+<dl><dt><a name="Artist-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
+ <a href="#Artist-findobj">findobj</a>(o=gcf(), match=None) <br>
+ <br>
+recursively find all :class:matplotlib.artist.<a href="#Artist">Artist</a> instances<br>
+contained in self<br>
+ <br>
+*match* can be<br>
+ <br>
+ - None: return all objects contained in artist (including artist)<br>
+ <br>
+ - function with signature ``boolean = match(artist)`` used to filter matches<br>
+ <br>
+ - class instance: eg Line2D. Only return artists of class type<br>
+ <br>
+.. plot:: ../mpl_examples/pylab_examples/findobj_demo.py</tt></dd></dl>
+
<dl><dt><a name="Artist-get_alpha"><strong>get_alpha</strong></a>(self)</dt><dd><tt>Return the alpha value used for blending - not supported on all<br>
backends</tt></dd></dl>
<dl><dt><a name="Artist-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
-<dl><dt><a name="Artist-get_axes"><strong>get_axes</strong></a>(self)</dt><dd><tt>return the axes instance the artist resides in, or None</tt></dd></dl>
+<dl><dt><a name="Artist-get_axes"><strong>get_axes</strong></a>(self)</dt><dd><tt>return the axes instance the artist resides in, or *None*</tt></dd></dl>
<dl><dt><a name="Artist-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
@@ -72,24 +90,27 @@
<dl><dt><a name="Artist-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
-<dl><dt><a name="Artist-get_contains"><strong>get_contains</strong></a>(self)</dt><dd><tt>return the _contains test used by the artist, or None for default.</tt></dd></dl>
+<dl><dt><a name="Artist-get_contains"><strong>get_contains</strong></a>(self)</dt><dd><tt>return the _contains test used by the artist, or *None* for default.</tt></dd></dl>
-<dl><dt><a name="Artist-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
+<dl><dt><a name="Artist-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.figure.Figure` instance the<br>
+artist belongs to.</tt></dd></dl>
<dl><dt><a name="Artist-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Artist-get_picker"><strong>get_picker</strong></a>(self)</dt><dd><tt>return the Pickeration instance used by this artist</tt></dd></dl>
-<dl><dt><a name="Artist-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>return the Transformation instance used by this artist</tt></dd></dl>
+<dl><dt><a name="Artist-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.transforms.Transform`<br>
+instance used by this artist.</tt></dd></dl>
-<dl><dt><a name="Artist-get_transformed_clip_path_and_affine"><strong>get_transformed_clip_path_and_affine</strong></a>(self)</dt><dd><tt>Return the clip path with the non-affine part of its transformation applied,<br>
-and the remaining affine part of its transformation.</tt></dd></dl>
+<dl><dt><a name="Artist-get_transformed_clip_path_and_affine"><strong>get_transformed_clip_path_and_affine</strong></a>(self)</dt><dd><tt>Return the clip path with the non-affine part of its<br>
+transformation applied, and the remaining affine part of its<br>
+transformation.</tt></dd></dl>
<dl><dt><a name="Artist-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Artist-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
-<dl><dt><a name="Artist-have_units"><strong>have_units</strong></a>(self)</dt><dd><tt>return True if units are set on the x or y axes</tt></dd></dl>
+<dl><dt><a name="Artist-have_units"><strong>have_units</strong></a>(self)</dt><dd><tt>return *True* if units are set on the x or y axes</tt></dd></dl>
<dl><dt><a name="Artist-hitlist"><strong>hitlist</strong></a>(self, event)</dt><dd><tt>List the children of the artist which contain the mouse event</tt></dd></dl>
@@ -99,25 +120,30 @@
<dl><dt><a name="Artist-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
-<dl><dt><a name="Artist-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt><a href="#Artist-pick">pick</a>(mouseevent)<br>
+<dl><dt><a name="Artist-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
-each child artist will fire a pick event if mouseevent is over<br>
+ <a href="#Artist-pick">pick</a>(mouseevent)<br>
+ <br>
+each child artist will fire a pick event if *mouseevent* is over<br>
the artist and the artist has picker set</tt></dd></dl>
-<dl><dt><a name="Artist-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return True if self is pickable</tt></dd></dl>
+<dl><dt><a name="Artist-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
-<dl><dt><a name="Artist-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect will not<br>
-be visible until the figure is redrawn, e.g., with ax.draw_idle().<br>
-Call ax.relim() to update the axes limits if desired.<br>
+<dl><dt><a name="Artist-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect<br>
+will not be visible until the figure is redrawn, e.g., with<br>
+:meth:`matplotlib.axes.Axes.draw_idle`. Call<br>
+:meth:`matplotlib.axes.Axes.relim` to update the axes limits<br>
+if desired.<br>
<br>
-Note: relim() will not see collections even if the collection<br>
-was added to axes with autolim=True.<br>
+Note: :meth:`~matplotlib.axes.Axes.relim` will not see<br>
+collections even if the collection was added to axes with<br>
+*autolim* = True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="Artist-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
-<dl><dt><a name="Artist-set"><strong>set</strong></a>(self, **kwargs)</dt><dd><tt>A tkstyle set command, pass kwargs to set properties</tt></dd></dl>
+<dl><dt><a name="Artist-set"><strong>set</strong></a>(self, **kwargs)</dt><dd><tt>A tkstyle set command, pass *kwargs* to set properties</tt></dd></dl>
<dl><dt><a name="Artist-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha value used for blending - not supported on<br>
all backends<br>
@@ -128,13 +154,13 @@
<br>
ACCEPTS: [True | False]</tt></dd></dl>
-<dl><dt><a name="Artist-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance the artist resides in, if any<br>
+<dl><dt><a name="Artist-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance in which the artist resides, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="Artist-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
-ACCEPTS: a matplotlib.transform.Bbox instance</tt></dd></dl>
+ACCEPTS: a :class:`matplotlib.transform.Bbox` instance</tt></dd></dl>
<dl><dt><a name="Artist-set_clip_on"><strong>set_clip_on</strong></a>(self, b)</dt><dd><tt>Set whether artist uses clipping<br>
<br>
@@ -142,35 +168,38 @@
<dl><dt><a name="Artist-set_clip_path"><strong>set_clip_path</strong></a>(self, path, transform<font color="#909090">=None</font>)</dt><dd><tt>Set the artist's clip path, which may be:<br>
<br>
- a) a Patch (or subclass) instance<br>
+ * a :class:`~matplotlib.patches.Patch` (or subclass) instance<br>
<br>
- b) a Path instance, in which cas aoptional transform may<br>
- be provided, which will be applied to the path before using it<br>
- for clipping.<br>
+ * a :class:`~matplotlib.path.Path` instance, in which case<br>
+ an optional :class:`~matplotlib.transforms.Transform`<br>
+ instance may be provided, which will be applied to the<br>
+ path before using it for clipping.<br>
<br>
- c) None, to remove the clipping path<br>
+ * *None*, to remove the clipping path<br>
<br>
For efficiency, if the path happens to be an axis-aligned<br>
rectangle, this method will set the clipping box to the<br>
-corresponding rectangle and set the clipping path to None.<br>
+corresponding rectangle and set the clipping path to *None*.<br>
<br>
-ACCEPTS: a Path instance and a Transform instance, a Patch<br>
-instance, or None</tt></dd></dl>
+ACCEPTS: a :class:`~matplotlib.path.Path` instance and a<br>
+:class:`~matplotlib.transforms.Transform` instance, a<br>
+:class:`~matplotlib.patches.Patch` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Artist-set_contains"><strong>set_contains</strong></a>(self, picker)</dt><dd><tt>Replace the contains test used by this artist. The new picker should<br>
be a callable function which determines whether the artist is hit by the<br>
-mouse event:<br>
+mouse event::<br>
<br>
hit, props = picker(artist, mouseevent)<br>
<br>
-If the mouse event is over the artist, return hit=True and props<br>
+If the mouse event is over the artist, return *hit=True* and *props*<br>
is a dictionary of properties you want returned with the contains test.</tt></dd></dl>
-<dl><dt><a name="Artist-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the figure instance the artist belong to<br>
+<dl><dt><a name="Artist-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the :class:`~matplotlib.figure.Figure` instance the artist<br>
+belongs to.<br>
<br>
-ACCEPTS: a matplotlib.figure.Figure instance</tt></dd></dl>
+ACCEPTS: a :class:`matplotlib.figure.Figure` instance</tt></dd></dl>
-<dl><dt><a name="Artist-set_label"><strong>set_label</strong></a>(self, s)</dt><dd><tt>Set the line label to s for auto legend<br>
+<dl><dt><a name="Artist-set_label"><strong>set_label</strong></a>(self, s)</dt><dd><tt>Set the line label to *s* for auto legend<br>
<br>
ACCEPTS: any string</tt></dd></dl>
@@ -182,37 +211,36 @@
<dl><dt><a name="Artist-set_picker"><strong>set_picker</strong></a>(self, picker)</dt><dd><tt>set the epsilon for picking used by this artist<br>
<br>
-picker can be one of the following:<br>
+*picker* can be one of the following:<br>
<br>
- None - picking is disabled for this artist (default)<br>
+ * *None*: picking is disabled for this artist (default)<br>
<br>
- boolean - if True then picking will be enabled and the<br>
+ * A boolean: if *True* then picking will be enabled and the<br>
artist will fire a pick event if the mouse event is over<br>
the artist<br>
<br>
- float - if picker is a number it is interpreted as an<br>
- epsilon tolerance in points and the the artist will fire<br>
+ * A float: if picker is a number it is interpreted as an<br>
+ epsilon tolerance in points and the artist will fire<br>
off an event if it's data is within epsilon of the mouse<br>
event. For some artists like lines and patch collections,<br>
the artist may provide additional data to the pick event<br>
- that is generated, eg the indices of the data within<br>
+ that is generated, e.g. the indices of the data within<br>
epsilon of the pick event<br>
<br>
- function - if picker is callable, it is a user supplied<br>
+ * A function: if picker is callable, it is a user supplied<br>
function which determines whether the artist is hit by the<br>
- mouse event.<br>
+ mouse event::<br>
<br>
hit, props = picker(artist, mouseevent)<br>
<br>
to determine the hit test. if the mouse event is over the<br>
- artist, return hit=True and props is a dictionary of<br>
- properties you want added to the PickEvent attributes<br>
+ artist, return *hit=True* and props is a dictionary of<br>
+ properties you want added to the PickEvent attributes.<br>
<br>
ACCEPTS: [None|float|boolean|callable]</tt></dd></dl>
-<dl><dt><a name="Artist-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>set the Transformation instance used by this artist<br>
- <br>
-ACCEPTS: a matplotlib.transform transformation instance</tt></dd></dl>
+<dl><dt><a name="Artist-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>Set the :class:`~matplotlib.transforms.Transform` instance<br>
+used by this artist.</tt></dd></dl>
<dl><dt><a name="Artist-set_visible"><strong>set_visible</strong></a>(self, b)</dt><dd><tt>set the artist's visiblity<br>
<br>
@@ -224,7 +252,7 @@
<dl><dt><a name="Artist-update"><strong>update</strong></a>(self, props)</dt></dl>
-<dl><dt><a name="Artist-update_from"><strong>update_from</strong></a>...
[truncated message content] |
