[Doc]: Improve new user guide sections · Issue #26366 · matplotlib/matplotlib · GitHub
Skip to content

[Doc]: Improve new user guide sections #26366

Description

@jklymak

Documentation Link

https://matplotlib.org/devdocs/users/explain/index.html

Problem

https://matplotlib.org/devdocs/users/explain/index.html has seen significant new material added. In particular

I'd expand this list to the quick-start guide:

which I think could use some revision in light of where it now stands in the docs (some things could be removed and reference other parts of the new User Guide)

I wrote these, and they had minimal input from others. I think they are necessary as placeholders and not embarrassing in their content. However, they could benefit from other input now that they are in place, and follow-on PRs (or issues if they are focused) are most welcome. Indeed I'll try and stay out of reviewing any changes, unless I really feel things are going off the rails. If we are talking further reorganization, I would like to be part of the conversation, and I'd encourage discussion before anyone puts a lot of work into that.

I don't think improving these is urgent, and can happen in point releases.

EDIT: Another important suggestions is more cross linking to the Examples.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions