Re: [matplotlib-devel] matplotlib user guide

[Michael D. <md...@st...>]

Thanks for the interest.  I agree there's lots that can be done to 
improve it.

You may want to familiarize yourself with MEP10 ( 
https://github.com/matplotlib/matplotlib/wiki/Mep10) though that mainly 
deals with docstrings and not the narrative documentation.

Perhaps as a starting point, you'd want to write a MEP with your 
specific proposals -- maybe as a set of guidelines for how the docs 
should be laid out (with a few concrete examples of such changes, but 
without going through the laborious process of making all such 
changes).  The nice thing about writing a MEP is that then we can point 
other people who want to help out to it and say "this is what we're 
trying to do", rather than the burden of all of the work being on just a 
single person.  At least that's the idea ;)

Mike

On 09/25/2013 04:19 AM, 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
> Mat...@li...
> https://lists.sourceforge.net/lists/listinfo/matplotlib-devel


-- 
                    _
|\/|o _|_  _. _ | | \.__  __|__|_|_  _  _ ._ _
|  ||(_| |(_|(/_| |_/|(_)(/_|_ |_|_)(_)(_)| | |

http://www.droettboom.com