Re: [Matplotlib-users] Documentation error/bug?

[Eric F. <ef...@ha...>]

On 07/28/2010 05:48 AM, Benjamin Root wrote:
> On Tue, Jul 27, 2010 at 1:31 PM, Friedrich Romstedt
> <fri...@gm... <mailto:fri...@gm...>> wrote:
>
>     2010/7/26 Benjamin Root <ben...@ou... <mailto:ben...@ou...>>:
>      > After some reading of sphinx documentation, it appears to be a
>     bug with
>      > sphinx (or actually, "smartypants") because it should not be
>     doing this sort
>      > of interpretation within a docstring.  Anyway, supposedly the
>     workaround is
>      > to put double backticks around the part that needs to be treated
>     literally:
>      > ``'--'``.  I tried this out and built the docs locally and it
>     works... sort
>      > of.  The text that is surrounded by double backticks are getting
>     a different
>      > background color.  This doesn't look great to me.  Maybe someone
>     else has a
>      > thought?
>
>     How looks a backticked empty string like?  If it is just nothing, it
>     could be used in between of the two hyphens, to separate them by
>     "nothing".  Still very hackish ... But it's just like LaTeX -{}-.
>
>     Friedrich
>
>
> Actually, I just took another look at the documentation and realized
> that the docstring for set_linestyle() was inconsistent with the docs
> for plot().  plot() have been using the backticks for a while now, so if
> we just use the double-backticks for all the values in set_linestyle()
> it would be consistent and look much better than it is now.
>
> I can make these changes and commit them to the trunk and the release
> branch, if that is ok.

Ben,

Sounds reasonable--go ahead.

Thanks.

Eric

>
> Ben Root
>
>
>
> ------------------------------------------------------------------------------
> 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-users mailing list
> Mat...@li...
> https://lists.sourceforge.net/lists/listinfo/matplotlib-users