DOC: update and copy-edit 2.0.0 release notes #25921
Conversation
The page was almost completely unreadable before, and the level 3 section headers were a random grab bag of topics. Now it's down to version numbers and links to the main sections (Improvements, Pull requests merged, etc.).
Fixes textual and formatting issues, adds missing section headers, groups some entries that belonged together in one section, etc. [skip actions] [skip cirrus] [skip azp]
|
LGTM, it seems like all of the info has been transfered. This can be improved in subsequent PRs. |
|
Thanks @rgommers |
|
I forgot to check that the release notes actually appear. They are not appearing in the rendered documents. Is towncrier deleting them? |
|
Ahh, we can add a |
|
Ah yes, will take that along in the next PR. |
|
Except it doesn't work. And when working around that, it seems there is no way to tell it to not stage things for committing (except for adding |
This allows accumulating snippets into the main release notes file and committing the result during a release cycle. It will also make Sphinx formatting errors, cross-link issues, etc. visible when docs get built locally. This will allow fixing them as we go, rather than leaving it broken in devdocs and then having to fix it in one go once `towncrier` is run once right before or after creating a release branch. xref numpygh-25921 and numpygh-25827 for recent issues with this. [skip azp] [skip actions] [skip cirrus]
This allows accumulating snippets into the main release notes file and committing the result during a release cycle. It will also make Sphinx formatting errors, cross-link issues, etc. visible when docs get built locally. This will allow fixing them as we go, rather than leaving it broken in devdocs and then having to fix it in one go once `towncrier` is run once right before or after creating a release branch. xref numpygh-25921 and numpygh-25827 for recent issues with this. [skip azp] [skip actions] [skip cirrus]
The complete copy-edit was a lot of work, so I left it at that and didn't try to also reorder sections or add highlights or other narrative content in this PR.