matplotlib-devel Mailing List for matplotlib

Fernando Perez wrote:
> I renamed it because there's a bit of a conflict with the current
> 'plot' directive, which allows a filename *or* a content block, but in
> that case the content block is meant to be the source code, as
> illustrated in sampledoc:
>
> http://matplotlib.sourceforge.net/sampledoc/extensions.html#inserting-matplotlib-plots
>
> Since I'm not sure if we can find a clean solution to:
>
> - path to script: goes into arg list
> - inlined (multiline) code: goes into content block
> - inlined (possibly multiline) caption: goes into content block
> 
I'm not sure it's that bad. It's certainly possible to do all these 
things with a single directive, since providing a path or providing 
source code is mutually exclusive. The thing one can't do is provide 
inline source *and* a caption. I applied your patch, renaming the 
directive back to "plot" and ran it over the matplotlib docs, and it 
doesn't seem to break anything.
Of course, we can also provide two directives, "plot" and "figplot" 
based on essentially the same source code. I'm kind of neutral on the 
matter.
Mike
-- 
Michael Droettboom
Science Software Branch
Operations and Engineering Division
Space Telescope Science Institute
Operated by AURA for NASA

Fernando Perez wrote:
> I renamed it because there's a bit of a conflict with the current
> 'plot' directive, which allows a filename *or* a content block, but in
> that case the content block is meant to be the source code, as
> illustrated in sampledoc:
>
> http://matplotlib.sourceforge.net/sampledoc/extensions.html#inserting-matplotlib-plots
>
> Since I'm not sure if we can find a clean solution to:
>
> - path to script: goes into arg list
> - inlined (multiline) code: goes into content block
> - inlined (possibly multiline) caption: goes into content block
> 
I'm not sure it's that bad. It's certainly possible to do all these 
things with a single directive, since providing a path or providing 
source code is mutually exclusive. The thing one can't do is provide 
inline source *and* a caption. I applied your patch, renaming the 
directive back to "plot" and ran it over the matplotlib docs, and it 
doesn't seem to break anything.
Of course, we can also provide two directives, "plot" and "figplot" 
based on essentially the same source code. I'm kind of neutral on the 
matter.
Mike
-- 
Michael Droettboom
Science Software Branch
Operations and Engineering Division
Space Telescope Science Institute
Operated by AURA for NASA