-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Improve our towncrier template, to do the right thing after releases #10580
Conversation
a2f4e81
to
77ff3d6
Compare
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.
Excellent! I was just gonna point a missing backticks, but then I saw you fixed them 😅.
Eh, they were all in comments. It is easier to just add eight characters, than to figure out how to disable the check which has caught this mistake in actual reST files. :) |
Yup :) Now, what is happening with the |
Yup yup, it’s exactly that. |
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.
I'm going to assume you already figured out all the -
newline suppressions because I never could myself.
This also adds a bunch of comments, which should serve as useful guides to future humans that work on these files.
77ff3d6
to
aa89947
Compare
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.
Is there an abbreviation for "looks like you know what you are doin'" ? :)
One of the joys of writing a Sphinx theme. 😅 The big quirk is that towncrier sets trim_blocks=True in Jinja, which makes it a bit more difficult to reason about.
😅 |
Improve our towncrier template, to do the right thing after releases
This also adds a bunch of comments, which should serve as useful guides
to future humans that work on these files.