rest table in matplotlib.lines.Line2D.set_marker

In response to a question on matplotlib-users, I added some additional documentation for the linestyles and markers in the matplotlib.lines API docs. Specifically, I added a rest table mapping the linestyle/marker to the meaning of the marker. Strangely, the set_linestyle table renders fine

http://matplotlib.sourceforge.net/api/artist_api.html#matplotlib.lines.Line2D.set_linestyle

but the table in set_marker is absent

http://matplotlib.sourceforge.net/api/artist_api.html#matplotlib.lines.Line2D.set_marker

I’ve tried cleanly building and installing mpl in my src tree, running svn-clean to make sure no cruft is impacting me, but I have not succeeeded in getting the marker table to render. Perhaps a fresh set of eyeballs can spot the problem. I’m pasting the docstrings below::

def set_linestyle(self, linestyle):
    """                                                                           
    Set the linestyle of the line (also accepts drawstyles)                       
                                                                                  
                                                                                  
    ================    =================                                         
    linestyle           description                                               
    ================    =================                                         
    '-'                 solid                                                     
    '--'                dashed                                                    
    '-.'                dash_dot                                                  
    ':'                 dotted                                                    
    'None'              draw nothing                                              
    ' '                 draw nothing                                              
    ''                  draw nothing                                              
    ================    =================    

                                                                                  
    .. seealso::                                                                  
        :meth:`set_drawstyle`                                                     
                                                                                  
    ACCEPTS: [ '-' | '--' | '-.' | ':' | 'None' | ' ' | '' ] and                  
    any drawstyle in combination with a linestyle, e.g. 'steps--'.                
    """

And here is set_marker docstring::

def set_marker(self, marker):
    """
    Set the line marker

    =========  ==========================
    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
    TICKLEFT   tickleft
    TICKRIGHT  tickright
    TICKUP     tickup
    TICKDOWN   tickdown
    CARETLEFT  caretleft
    CARETRIGHT caretright
    CARETUP    caretup
    CARETDOWN  caretdown
    'None'     nothing
    ' '        nothing
    ''         nothing
    =========  ==========================

    ACCEPTS: [ '+' | '*' | ',' | '.' | '1' | '2' | '3' | '4'
             > '<' | '>' | 'D' | 'H' | '^' | '_' | 'd'
             > 'h' | 'o' | 'p' | 's' | 'v' | 'x' | '|'
             > TICKUP | TICKDOWN | TICKLEFT | TICKRIGHT
             > 'None' | ' ' | '' ]

    """

John,

I guess the number of "=" of the first column should be 10 (now 9),
because of 'CARETRIGHT'.

I submitted the change to the TRUNK.

-JJ

···

On Wed, Dec 10, 2008 at 9:50 PM, John Hunter <jdh2358@...149...> wrote:

In response to a question on matplotlib-users, I added some additional
documentation for the linestyles and markers in the matplotlib.lines API
docs. Specifically, I added a rest table mapping the linestyle/marker to
the meaning of the marker. Strangely, the set_linestyle table renders fine

http://matplotlib.sourceforge.net/api/artist_api.html#matplotlib.lines.Line2D.set_linestyle

but the table in set_marker is absent

http://matplotlib.sourceforge.net/api/artist_api.html#matplotlib.lines.Line2D.set_marker

I've tried cleanly building and installing mpl in my src tree, running
svn-clean to make sure no cruft is impacting me, but I have not succeeeded
in getting the marker table to render. Perhaps a fresh set of eyeballs can
spot the problem. I'm pasting the docstrings below::

    def set_linestyle(self, linestyle):

"""
        Set the linestyle of the line (also accepts
drawstyles)

        ================

        linestyle
description
        ================

        '-'
solid
        '--'
dashed
        '-.'
dash_dot
        ':'
dotted
        'None' draw
nothing
        ' ' draw
nothing
        '' draw
nothing
        ================ =================

        ..
seealso::

:meth:`set_drawstyle`

        ACCEPTS: [ '-' | '--' | '-.' | ':' | 'None' | ' ' | '' ]
and
        any drawstyle in combination with a linestyle, e.g.
'steps--'.
        """

And here is set_marker docstring::

    def set_marker(self, marker):
        """
        Set the line marker

        ========= ==========================
        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
        TICKLEFT tickleft
        TICKRIGHT tickright
        TICKUP tickup
        TICKDOWN tickdown
        CARETLEFT caretleft
        CARETRIGHT caretright
        CARETUP caretup
        CARETDOWN caretdown
        'None' nothing
        ' ' nothing
        '' nothing
        ========= ==========================

        ACCEPTS: [ '+' | '*' | ',' | '.' | '1' | '2' | '3' | '4'
                 > '<' | '>' | 'D' | 'H' | '^' | '_' | 'd'
                 > 'h' | 'o' | 'p' | 's' | 'v' | 'x' | '|'
                 > TICKUP | TICKDOWN | TICKLEFT | TICKRIGHT
                 > 'None' | ' ' | '' ]

        """

------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you. Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/matplotlib-devel