Revision: 8593
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=8593&view=rev
Author: weathergod
Date: 2010-07-29 16:16:17 +0000 (Thu, 29 Jul 2010)
Log Message:
-----------
Fix documentation for set_linestyle() and set_marker() and a few other
functions properly display their available values on the web docs.
Also changed pentagram to pentagon in the docstrings.
Modified Paths:
--------------
branches/v1_0_maint/lib/matplotlib/artist.py
branches/v1_0_maint/lib/matplotlib/axes.py
branches/v1_0_maint/lib/matplotlib/lines.py
Modified: branches/v1_0_maint/lib/matplotlib/artist.py
===================================================================
--- branches/v1_0_maint/lib/matplotlib/artist.py 2010-07-29 14:09:11 UTC
(rev 8592)
+++ branches/v1_0_maint/lib/matplotlib/artist.py 2010-07-29 16:16:17 UTC
(rev 8593)
@@ -826,7 +826,7 @@
for a line that begins with ACCEPTS:
Eg., for a line linestyle, return
- [ '-' | '--' | '-.' | ':' | 'steps' | 'None' ]
+ "[ ``'-'`` | ``'--'`` | ``'-.'`` | ``':'`` | ``'steps'`` | ``'None'``
]"
"""
name = 'set_%s'%attr
Modified: branches/v1_0_maint/lib/matplotlib/axes.py
===================================================================
--- branches/v1_0_maint/lib/matplotlib/axes.py 2010-07-29 14:09:11 UTC (rev
8592)
+++ branches/v1_0_maint/lib/matplotlib/axes.py 2010-07-29 16:16:17 UTC (rev
8593)
@@ -5549,22 +5549,22 @@
*marker*:
can be one of:
- ===== ==============
- Value Description
- ===== ==============
- 's' square
- 'o' circle
- '^' triangle up
- '>' triangle right
- 'v' triangle down
- '<' triangle left
- 'd' diamond
- 'p' pentagram
- 'h' hexagon
- '8' octagon
- '+' plus
- 'x' cross
- ===== ==============
+ ======= ==============
+ Value Description
+ ======= ==============
+ ``'s'`` square
+ ``'o'`` circle
+ ``'^'`` triangle up
+ ``'>'`` triangle right
+ ``'v'`` triangle down
+ ``'<'`` triangle left
+ ``'d'`` diamond
+ ``'p'`` pentagon
+ ``'h'`` hexagon
+ ``'8'`` octagon
+ ``'+'`` plus
+ ``'x'`` cross
+ ======= ==============
The marker can also be a tuple (*numsides*, *style*,
*angle*), which will create a custom, regular symbol.
@@ -5655,7 +5655,7 @@
'v' : (3,math.pi,0), # triangle down
'<' : (3,3*math.pi/2.0,0), # triangle left
'd' : (4,0,0), # diamond
- 'p' : (5,0,0), # pentagram
+ 'p' : (5,0,0), # pentagon
'h' : (6,0,0), # hexagon
'8' : (8,0,0), # octagon
'+' : (4,0,2), # plus
Modified: branches/v1_0_maint/lib/matplotlib/lines.py
===================================================================
--- branches/v1_0_maint/lib/matplotlib/lines.py 2010-07-29 14:09:11 UTC (rev
8592)
+++ branches/v1_0_maint/lib/matplotlib/lines.py 2010-07-29 16:16:17 UTC (rev
8593)
@@ -712,13 +712,13 @@
================ =================
linestyle description
================ =================
- '-' solid
- '--' dashed
- '-.' dash_dot
- ':' dotted
- 'None' draw nothing
- ' ' draw nothing
- '' draw nothing
+ ``'-'`` solid
+ ``'--'`` dashed
+ ``'-.'`` dash_dot
+ ``':'`` dotted
+ ``'None'`` draw nothing
+ ``' '`` draw nothing
+ ``''`` draw nothing
================ =================
'steps' is equivalent to 'steps-pre' and is maintained for
@@ -729,8 +729,8 @@
:meth:`set_drawstyle`
To set the drawing style (stepping) of the plot.
- ACCEPTS: [ '-' | '--' | '-.' | ':' | 'None' | ' ' | '' ] and
- any drawstyle in combination with a linestyle, e.g. 'steps--'.
+ ACCEPTS: [ ``'-'`` | ``'--'`` | ``'-.'`` | ``':'`` | ``'None'`` | ``'
'`` | ``''`` ]
+ and any drawstyle in combination with a linestyle, e.g. ``'steps--'``.
"""
for ds in self.drawStyleKeys: # long names are first in the list
@@ -759,28 +759,28 @@
========== ==========================
marker description
========== ==========================
- '.' point
- ',' pixel
- 'o' circle
- 'v' triangle_down
- '^' triangle_up
- '<' triangle_left
- '>' triangle_right
- '1' tri_down
- '2' tri_up
- '3' tri_left
- '4' tri_right
- 's' square
- 'p' pentagon
- '*' star
- 'h' hexagon1
- 'H' hexagon2
- '+' plus
- 'x' x
- 'D' diamond
- 'd' thin_diamond
- '|' vline
- '_' hline
+ ``'.'`` point
+ ``','`` pixel
+ ``'o'`` circle
+ ``'v'`` triangle_down
+ ``'^'`` triangle_up
+ ``'<'`` triangle_left
+ ``'>'`` triangle_right
+ ``'1'`` tri_down
+ ``'2'`` tri_up
+ ``'3'`` tri_left
+ ``'4'`` tri_right
+ ``'s'`` square
+ ``'p'`` pentagon
+ ``'*'`` star
+ ``'h'`` hexagon1
+ ``'H'`` hexagon2
+ ``'+'`` plus
+ ``'x'`` x
+ ``'D'`` diamond
+ ``'d'`` thin_diamond
+ ``'|'`` vline
+ ``'_'`` hline
TICKLEFT tickleft
TICKRIGHT tickright
TICKUP tickup
@@ -789,19 +789,23 @@
CARETRIGHT caretright
CARETUP caretup
CARETDOWN caretdown
- 'None' nothing
- ' ' nothing
- '' nothing
+ ``'None'`` nothing
+ ``' '`` nothing
+ ``''`` nothing
'$...$' render the string using mathtext
========== ==========================
- ACCEPTS: [ '+' | '*' | ',' | '.' | '1' | '2' | '3' | '4'
- | '<' | '>' | 'D' | 'H' | '^' | '_' | 'd'
- | 'h' | 'o' | 'p' | 's' | 'v' | 'x' | '|'
+ ACCEPTS: [ ``'+'`` | ``'*'`` | ``','`` | ``'.'``
+ | ``'1'`` | ``'2'`` | ``'3'`` | ``'4'``
+ | ``'<'`` | ``'>'`` | ``'D'`` | ``'H'``
+ | ``'^'`` | ``'_'`` | ``'d'`` | ``'h'``
+ | ``'o'`` | ``'p'`` | ``'s'`` | ``'v'``
+ | ``'x'`` | ``'|'``
| TICKUP | TICKDOWN | TICKLEFT | TICKRIGHT
- | 'None' | ' ' | '' | '$...$']
+ | CARETUP | CARETDOWN | CARETLEFT | CARETRIGHT
+ | ``'None'`` | ``' '`` | ``''`` | '$...$']
"""
if marker in self._markers:
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
The Palm PDK Hot Apps Program offers developers who use the
Plug-In Development Kit to bring their C/C++ apps to Palm for a share
of $1 Million in cash or HP Products. Visit us here for more details:
http://p.sf.net/sfu/dev2dev-palm
_______________________________________________
Matplotlib-checkins mailing list
Matplotlib-checkins@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins
