Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Improve various release notes #20919

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 6 commits into from
Aug 28, 2021
Merged

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Aug 27, 2021

PR Summary

Adds dates on What's new and GitHub statistics pages. Rename section titles to be consistent.

And one giant commit fixing the weird rendering of the very old changelog. I expect GitHub will not do a good job of showing that diff, but it is essentially splitting the text after the date to turn it into a correct definition list.

PR Checklist

  • [n/a] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • [n/a] 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).
  • [n/a] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [n/a] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

And make all the title consistent.

Fixes matplotlib#6864.
Though, I left out anything older than 1.0, since those are all
aggregated at the end.
And tweak some of the wording.
Since Sphinx treats these lines as mostly a single paragraph, this is a
by-rote commit to re-wrap everything properly. Do not expect the entire
file to look good; it just will no longer randomly switch between bold
and not.

The only non-rote change is to turn the release message into a section
heading.
@QuLogic QuLogic added this to the v3.5.0 milestone Aug 27, 2021
@QuLogic
Copy link
Member Author

QuLogic commented Aug 27, 2021

I also considered increasing the maxdepth of the toctrees in the release_notes.rst, matching a bit closer how Pandas release notes look. This seems okay in the latest versions (as I gave them all subsections), but may not be great for some of the older ones.

==============================
.. _whats-new-3-3-0:

=============================================
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
=============================================

To be consistent with the older what's new files?

Copy link
Member Author

@QuLogic QuLogic Aug 27, 2021

Choose a reason for hiding this comment

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

No, the grouping section headings are already =, so this needs to be a level higher. Older files don't have grouping.

==============================
.. _whats-new-3-4-0:

=============================================
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
=============================================

To be consistent with the older what's new files?

@timhoffm
Copy link
Member

Just noticed: We're missing some github stats:

  • 3.0.0
  • 3.0.1
  • 3.0.3
  • 3.1.3

Would be nice to have them complete. But that doesn't necessarily have to be within this PR.

@QuLogic
Copy link
Member Author

QuLogic commented Aug 27, 2021

It also appears that the 3.1.2 stats are a copy of 3.1.1

@timhoffm timhoffm merged commit 276a9f3 into matplotlib:master Aug 28, 2021
@lumberbot-app
Copy link

lumberbot-app bot commented Aug 28, 2021

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
$ git checkout v3.5.x
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 276a9f3599a3611bcdfbd4cfb8f852bfda19b48d
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #20919: Improve various release notes'
  1. Push to a named branch :
git push YOURFORK v3.5.x:auto-backport-of-pr-20919-on-v3.5.x
  1. Create a PR against branch v3.5.x, I would have named this PR:

"Backport PR #20919 on branch v3.5.x (Improve various release notes)"

And apply the correct labels and milestones.

Congratulation you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove Still Needs Manual Backport label once the PR gets merged.

If these instruction are inaccurate, feel free to suggest an improvement.

timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Aug 28, 2021
@QuLogic QuLogic deleted the release-dates branch August 30, 2021 20:26
QuLogic added a commit that referenced this pull request Aug 30, 2021
…v3.5.x

Backport PR #20919 on branch v3.5.x (Improve various release notes)"
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.

3 participants