-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
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
Conversation
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.
I also considered increasing the |
============================== | ||
.. _whats-new-3-3-0: | ||
|
||
============================================= |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
============================================= |
To be consistent with the older what's new files?
There was a problem hiding this comment.
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: | ||
|
||
============================================= |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
============================================= |
To be consistent with the older what's new files?
Just noticed: We're missing some github stats:
Would be nice to have them complete. But that doesn't necessarily have to be within this PR. |
It also appears that the 3.1.2 stats are a copy of 3.1.1 |
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
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 If these instruction are inaccurate, feel free to suggest an improvement. |
…v3.5.x Backport PR #20919 on branch v3.5.x (Improve various release notes)"
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
pytest
passes).flake8
on changed files to check).flake8-docstrings
and runflake8 --docstring-convention=all
).doc/users/next_whats_new/
(follow instructions in README.rst there).doc/api/next_api_changes/
(follow instructions in README.rst there).