add changelog for message spec #525
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
back to 5.0, when we started tracking these things
MSeal
reviewed
Feb 28, 2020
There was a problem hiding this comment.
I think it's fine to have the information replicated somewhat. We could do doc linking from one to the other though that can get tedious to write correctly, or just leave a note at the top of both docs that the other one exists? Just so long as the release instructions are updated to clearly specify what's expected and how to do it (I added a RELEASING.md file with 6.0 copied and modified from other jupyter projects)
|
@minrk Should we merge this as is? |
|
I agree with @willingc, I think this can merge as-is for the upcoming 7.0 release |
rgbkrk
approved these changes
Dec 23, 2021
Co-authored-by: David Brochart <david.brochart@gmail.com>
Co-authored-by: David Brochart <david.brochart@gmail.com>
willingc
approved these changes
Dec 23, 2021
|
@davidbrochart If this looks good to you after CI, please 🚢 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As requested in #520
Changelog goes back to 5.0 (inclusive), when we started tracking these things well and third-party implementations really got going.
Marked as draft because I'm not sure this is the right way to do it. The changelog info is entirely redundant with the
version changed/added/deprecatednotes (that's where I got the changes), so it means every time we document a change, we must do it twice.Since Sphinx is fancy about roles, maybe there's a better automated way to display this information twice? Or maybe we should replace the local-to-the-message change notes with the changelog? I'm not sure. For me, the version changed notes near the messages that have changed seems preferable, but as brought up in #520 it's not efficient for a Kernel author who implements protocol 5.0 and asks "what do I need to change to support 5.4?" which is currently to search the doc for "New in" and "changed".