NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.4k

Documentation Style Guide for contributors#20216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

story645 merged 2 commits intomatplotlib:masterfromjeromefv:docs_style_guide

May 14, 2021

Merged

Documentation Style Guide for contributors#20216

story645 merged 2 commits intomatplotlib:masterfromjeromefv:docs_style_guide

May 14, 2021

Conversation

Copy link

Contributor

jeromefv commentedMay 13, 2021

PR Summary

Added Documentation Style guide fromGetting Started GSoD #19183
Included reference in TOC tree for developers-guide-index .rst file

PR Checklist

Has pytest style unit tests (andpytest passes).
IsFlake 8 compliant (runflake8 on changed files to check).
New features are documented, with examples if plot related.
Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
Conforms to Matplotlib style conventions (installflake8-docstrings and runflake8 --docstring-convention=all).
New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).

jeromefv added2 commits

May 12, 2021 20:02

Added style_guide.rst from PR#19183

7ccb7a8

Added style_guide.rst to dev guide index TOC tree

3abedd9

jklymak approved these changes

May 14, 2021

View reviewed changes

Copy link

Member

jklymak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I've not gone over this with a fine comb, but I think others have. Suggest we merge this so further PRs can be made on it if there is further copy-editing/suggestions. I think this is a worthwhile section to have.