Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a proposal for a slightly modified changelog format.
Previously, the changelog header for the most recent stable release included
(current release)
appended to the release version, and the latest development version included(development release)
. These parentheticals in the changelog headers are largely superfluous, since it should be clear from context which is the most recent stable release and the development version, whether you are on thestable
orlatest
branches of the documentation webpage, respectively: it's the first one in the list! Furthermore, "development release" is a misnomer since the "latest" version of the software has not been formally released.I propose to drop the
(current release)
, so that the release notes for thestable
branch of the docs appear asAnd to append
-dev
to the version under development, so that the release notes for thelatest
branch of the docs appear asThis PR also includes some editorial changes to the changelog (fixed typos, added missing punctuation, reworded some changelog entries).