FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Documentation Style Guide for contributors by jeromefv · Pull Request #20216 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

Documentation Style Guide for contributors - #20216

Merged
story645 merged 2 commits into
matplotlib:masterfrom
jeromefv:docs_style_guide
May 14, 2021
ConversationCommits (2)ChecksFiles changed
Merged

Documentation Style Guide for contributors#20216
story645 merged 2 commits into
matplotlib:masterfrom
jeromefv:docs_style_guide

Conversation

jeromefv commented May 13, 2021

Copy link
Copy Markdown
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 approved these changes May 14, 2021
View reviewed changes

jklymak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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 added this to the v3.5.0 milestone May 14, 2021

jklymak commented May 14, 2021

Copy link
Copy Markdown
Member

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

story645 merged commit 772e382 into matplotlib:master May 14, 2021
timhoffm mentioned this pull request May 16, 2021
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

story645 story645 approved these changes
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

Back | FazBrowse Home | New Git URL