Re: [matplotlib-devel] matplotlib user guide

2013-10-31 Thread mark
Thank you all for the thoughts so far

I have raised a pull request:
https://github.com/matplotlib/matplotlib/pull/2554

To be clear, this is a 'structure only' pull request, I have made no
documentation changes as yet.

I see this as a part of the process.  If we can agree structure we can
work on aspects of the user guide, adding content into appropriate
sections.

all the best
mark

On Wed, 25 Sep 2013 08:19:59 +
mark  wrote:

> hi matplotlib developers
> 
> I have been considering the matplotlib user guide structure and it
> has occured to me that there are two user guides interleaved here:
>   1. Introduction for new users
>   2. Library tour for developers
> 
> I think that this structure makes it challenging for new users to
> benefit from the user guide as much as they could.  
> 
> I would like to see the user guide separated into two sections, with
> the two different audiences in mind.  I feel this would enable new
> users of the library to have a more targeted introduction to some of
> the neat features without getting bogged down in details they are
> unlikely to need (or comprehend). 
> 
> I am very happy to have a go at this and put up a set of suggested
> changes but I would value input from the community on this approach
> and my category suggestions before I submit a pull request.
> 
> many thanks
> mark
> 
> 
> --
> October Webinars: Code for Performance
> Free Intel webinars can help you accelerate application performance.
> Explore tips for MPI, OpenMP, advanced profiling, and more. Get the
> most from the latest Intel processors and coprocessors. See abstracts
> and register >
> http://pubads.g.doubleclick.net/gampad/clk?id=60133471&iu=/4140/ostg.clktrk
> ___ Matplotlib-devel
> mailing list [email protected]
> https://lists.sourceforge.net/lists/listinfo/matplotlib-devel


--
Android is increasing in popularity, but the open development platform that
developers love is also attractive to malware creators. Download this white
paper to learn more about secure code signing practices that can help keep
Android apps secure.
http://pubads.g.doubleclick.net/gampad/clk?id=65839951&iu=/4140/ostg.clktrk
___
Matplotlib-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-devel


Re: [matplotlib-devel] matplotlib Hangout today at 14:00 UTC (10:00am ET)

2013-10-31 Thread Chris Barker
On Fri, Oct 25, 2013 at 3:32 PM, Todd  wrote:

> I think one thing that contributes a lot to the API issues is the
> inconsistency between pyplot API and the OO API.  There isn't any reason
> the APIs need to be so different.
>

indeed.

I hadn't even realized how different they were.


> So the idea would be to have essentially all of the pyplot functions just
> be wrappers for methods from other classes, using the same name and same
> call signature (minus "self").  All of the actual functionality would be
> implemented in the methods, the pyplot functions should not have any logic
> or tests.
>

+ inf

However, doing this with full backward compatibility could be a real
challenge...

This will make it easy to transition between the two, learning to use the
> OO interface would just involve learning what object the pyplot function is
> targeting (this should be in the pyplot function docstring).
>

That would help, though a namespace without any non-OO stuff would be still
be good, and, of course, docs and tutorials.

-Chris

-- 

Christopher Barker, Ph.D.
Oceanographer

Emergency Response Division
NOAA/NOS/OR&R(206) 526-6959   voice
7600 Sand Point Way NE   (206) 526-6329   fax
Seattle, WA  98115   (206) 526-6317   main reception

[email protected]
--
Android is increasing in popularity, but the open development platform that
developers love is also attractive to malware creators. Download this white
paper to learn more about secure code signing practices that can help keep
Android apps secure.
http://pubads.g.doubleclick.net/gampad/clk?id=65839951&iu=/4140/ostg.clktrk___
Matplotlib-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-devel