Skip to content

DOC: update release guide #13421

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Feb 19, 2019
Merged

Conversation

tacaswell
Copy link
Member

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@tacaswell tacaswell added this to the v3.1.0 milestone Feb 12, 2019
QuLogic and others added 5 commits February 12, 2019 00:00
Co-Authored-By: tacaswell <tcaswell@gmail.com>
Co-Authored-By: tacaswell <tcaswell@gmail.com>
Co-Authored-By: tacaswell <tcaswell@gmail.com>
@tacaswell
Copy link
Member Author

Thank you @QuLogic


The list below is a table of contents of individual files from the 'next_api_changes' folder.
When a release is made
The list below is a table of contents of individual files from the 'next_api_changes' folder.
Copy link
Member

Choose a reason for hiding this comment

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

Indent by the same amout as the following list items. (Can never decide if I want 3 or 4 spaces in rst files 😃 ).

----------------------------

Before tagging, update the "what's new" and API changes listings.

Copy link
Member

Choose a reason for hiding this comment

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

If you want to be very clear add a line

For "what's new"

@timhoffm
Copy link
Member

Maybe add an info admonition to the top of the page "This document is only relevant for matplotlib release managers."

While the first sentence reads "A guide for developers who are doing a matplotlib release.", it cannot hurt to make it very obvious that this page is of no concern to the bypasser. People don't read precisely 😄 .

Copy link
Member

@NelleV NelleV left a comment

Choose a reason for hiding this comment

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

Thanks @tacaswell !
I'm not merging as there are still comments remaining, but for me 👍 It's already a huge improvements on what we had before.

@dstansby dstansby merged commit 7a7a40f into matplotlib:master Feb 19, 2019
@tacaswell tacaswell deleted the doc_release_notes branch February 22, 2019 23:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants