Re: [matplotlib-devel] matplotlib user guide

[Phil E. <pel...@gm...>]

For the record, I've spoken to Mark about this face-to-face in the past,
and I think he has some great ideas about how the user guide should look.

Personally I would agree that the user guide is currently not targeted
enough (it takes 3 pages full of text before getting to a simple plt.plot()
) and even then, I don't think it is sympathetic enough to really new
users. Clearly matplotlib's success shows that the documentation must be
doing something right, but I think the user guide could definitely be
improved.

Mark, from what I remember your changes were along the lines of moving
sections around, and splitting some sections into beginner & advanced
pages. I think detailing a few examples of the types of changes you have in
mind might help us to have a bit more clarity on what you are proposing.

Thanks for getting involved in improving the docs!



On 25 September 2013 09:19, mark <ma...@me...> 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
>