📚 CHANGELOG.md: improve release notes for v4.5.0
#1008
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
mbercx
force-pushed
the
docs/changelog
branch
2 times, most recently
from
ce09eb9 to
c961ce4
Compare
|
@sphuber @AndresOrtegaGuerrero wanted to update these a bit before doing the v4.5.1 patch release to fix the bugs introduced by the new q-points inputs. |
The release notes of `v4.5.0` did not add any explanation of the main changes and some useful code snippets. Since there was actually a breaking change related to how q-points are defined for the `PhBaseWorkChain`, adding some notes (that can then be copied to the documentation) is useful. Moreover, the subsections for the full list of changes did not respect the same order as previous release notes, which offended the OCD of one of the more picky and annoying developers. Hence, we correct this egregious error, and also add a specific section to put commits that only affect tests.
mbercx
force-pushed
the
docs/changelog
branch
from
c961ce4 to
272ee12
Compare
sphuber
approved these changes
Feb 13, 2024
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.
The release notes of
v4.5.0did not add any explanation of the main changes and some useful code snippets. Since there was actually a breaking change related to how q-points are defined for thePhBaseWorkChain, adding some notes (that can then be copied to the documentation) is useful.Moreover, the subsections for the full list of changes did not respect the same order as previous release notes, which offended the OCD of one of the more picky and annoying developers. Hence, we correct this egregious error, and also add a specific section to put commits that only affect tests.