Skip to content
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

Merged
merged 1 commit into from
Oct 15, 2021

Conversation

pradyunsg
Copy link
Member

This also adds a bunch of comments, which should serve as useful guides
to future humans that work on these files.

@pradyunsg pradyunsg added this to the 21.3.1 milestone Oct 12, 2021
@pradyunsg pradyunsg force-pushed the better-towncrier-template branch from a2f4e81 to 77ff3d6 Compare October 12, 2021 18:35
@DiddiLeija DiddiLeija added the skip news Does not need a NEWS file entry (eg: trivial changes) label Oct 12, 2021
Copy link
Member

@DiddiLeija DiddiLeija left a 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 😅.

@pradyunsg
Copy link
Member Author

I was just gonna point a missing backticks

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. :)

@DiddiLeija
Copy link
Member

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 vendoring step? Maybe this is related to #10570

@pradyunsg
Copy link
Member Author

Yup yup, it’s exactly that.

Copy link
Member

@uranusjr uranusjr left a 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.
@pradyunsg pradyunsg force-pushed the better-towncrier-template branch from 77ff3d6 to aa89947 Compare October 15, 2021 14:11
Copy link
Member

@sbidoul sbidoul left a 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'" ? :)

@pradyunsg
Copy link
Member Author

pradyunsg commented Oct 15, 2021

I'm going to assume you already figured out all the - newline suppressions because I never could myself.

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.

Is there an abbreviation for "looks like you know what you are doin'" ? :)

😅

@pradyunsg pradyunsg merged commit bf71afc into pypa:main Oct 15, 2021
@pradyunsg pradyunsg deleted the better-towncrier-template branch October 15, 2021 17:31
pradyunsg added a commit to pradyunsg/pip that referenced this pull request Oct 22, 2021
Improve our towncrier template, to do the right thing after releases
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 31, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
skip news Does not need a NEWS file entry (eg: trivial changes)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants