Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Final documentation improvements #8555

Closed
@choldgraf

Description

@choldgraf

After many weeks of work I think that the documentation is in a much better state now. I think that we are 80% of the way towards considering this "good enough" for now. This issue is a place to keep some lingering issues / ideas that could be implemented before 2.1 is released:

ToDo

  • Cycler documentation
    Use of the cycler should be demoed more extensively in the examples, and should also be introduced and explained in an introductory tutorial. See scipy2017 sprint - docs #8885

  • The developers guide should be updated and made more clear. outside the scope of this issue I think

  • This blog post or something like it should be converted into a "getting started with matplotlib" kind of thing. Maybe we should reach out to the author and ask them to submit it as a sphinx-gallery python file.

  • We need to go through all the open PRs that were working on sphinx gallery and make sure that they get either closed because the work has already been done, or merged soon otherwise they'll quickly become forgotten PRs.

In progress

I think this will go a long way towards bringing MPL's documentation into the 21st century.

As a general thought, any time somebody writes a blog post that makes an incorrect assumption about matplotlib, e.g. this one, we should take a hard look at the docs and figure out how to make that feature/ use-case easier to find. In addition, any time somebody writes a clear, well-written blog post that is better at explaining things than the MPL docs, we should improve the docs or ask that person to contribute their post as a tutorial.

Let me know if there are any other suggestions for this issue and I can append to the list. Is there any ETA on 2.1? I wanna make sure this is a realistic goal.

@story645 @NelleV @tacaswell @phobson @anntzer @dopplershift @QuLogic

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions