-
Notifications
You must be signed in to change notification settings - Fork 122
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix section depth in markdown template #664
base: trunk
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR.
Changes looks good... but this might be considered a backward incompatible change.
Users that already have NEWS files, will have them generated with H3 for previous releases.
I think that this might be ok, but we should communicate this change to end users.
I was expected to also see some updates to the test docstrings, to explain that the H2 render is important.
I hope that someone who cares about MD support in towncrier will have some time and do a review of this PR
@@ -0,0 +1 @@ | |||
Markdown template: Render category headers as h2 when no sections are present. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a small comment... and mauybe this should be a .removal
type of fragment.
It should explain the existing users should manually update existing NEWS file to match the new H2 format.
Markdown template: Render category headers as h2 when no sections are present. | |
When no sections are present, the default Markdown template now renders the category headers as H2. In previous versions it was rendered as H3. |
Hi @adiroiban, I commented a bit on the bigger problem here: #663 maybe you’d like to chime in there before I invest more time into this fix |
Description
Fixes #663
Checklist
src/towncrier/newsfragments/
. Briefly describe yourchanges, with information useful to end users. Your change will be included in the public release notes.
docs/tutorial.rst
is still up-to-date.