Fix documentation of fragment configuration in README#425
Merged
adiroiban merged 2 commits intotwisted:trunkfrom Sep 6, 2022
Merged
Fix documentation of fragment configuration in README#425adiroiban merged 2 commits intotwisted:trunkfrom
adiroiban merged 2 commits intotwisted:trunkfrom
Conversation
Update to match what the code expects and how this is documented in https://towncrier.readthedocs.io/en/stable/configuration.html
cdf5426 to
698288d
Compare
Codecov Report
@@ Coverage Diff @@
## trunk #425 +/- ##
=======================================
Coverage 96.91% 96.91%
=======================================
Files 13 13
Lines 551 551
Branches 112 112
=======================================
Hits 534 534
Misses 9 9
Partials 8 8 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
adiroiban
approved these changes
Sep 6, 2022
Member
adiroiban
left a comment
There was a problem hiding this comment.
Thanks. Much appreciated.
I will merge this as this is better than what we have in trunk.
Another option is not to have any example config inside README and just link to the docs.
But can be done in another PR.
bors bot
added a commit
to microsoft/Qcodes
that referenced
this pull request
Sep 7, 2022
4580: Use Towncriers new config format r=jenshnielsen a=jenshnielsen The old one is deprecated and this is less verbose and nicer. Note that the format documented in the readme is actually wrong twisted/towncrier#425 4583: Validate pyproject.toml in precommit hook r=jenshnielsen a=jenshnielsen Co-authored-by: Jens H. Nielsen <Jens.Nielsen@microsoft.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
2 participants
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.
Description
Update to match what the code expects and how this is documented
in https://towncrier.readthedocs.io/en/stable/configuration.html
Fixes #424
Checklist
src/towncrier/newsfragments/. Describe yourchange and include important information. Your change will be included in the public release notes.