Skip to content

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
May 14, 2021
Merged

Documentation Style Guide for contributors #20216

merged 2 commits into from
May 14, 2021

Conversation

jeromefv
Copy link
Contributor

PR Summary

PR Checklist

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

jklymak
jklymak approved these changes May 14, 2021
View reviewed changes
Copy link
Member

@jklymak 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.

@jklymak jklymak added this to the v3.5.0 milestone May 14, 2021
@jklymak
Copy link
Member

jklymak commented May 14, 2021

BTW, @jeromefv thanks a lot for splitting off into a separate PR!

@story645 story645 merged commit 772e382 into matplotlib:master May 14, 2021
@timhoffm timhoffm mentioned this pull request May 16, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@story645 story645 story645 approved these changes

@jklymak jklymak jklymak approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.5.0
Development

Successfully merging this pull request may close these issues.
3 participants
@jeromefv @jklymak @story645