The changelog claimed a change that is not in this release - #135
Merged
Conversation
`says which field and why` describes #131, which is still open. Without it the log names the field it dropped and not the reason, so the line said more than the release does. Signed-off-by: thc1006 <84045975+thc1006@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Caught while drafting the v0.1.1 release notes.
The 0.1.1 section says the environment
says which field and why (#117, #131). #131 is still open, so without it the log names the field it dropped and not the reason. The line promised more than the release delivers.I checked every other number in that section against what is actually on
develop. #128 is the only other one without its own merge commit there, and that is because #132 carried its commits, so the content is in. Everything else lines up.Fixing the sentence rather than merging #131 to make it true: the release is what you approved, and the changelog should describe it rather than shape it. #131 stays open for 0.1.2.