-
-
Notifications
You must be signed in to change notification settings - Fork 628
Link to genuine pull requests from README examples #2217
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
Link to genuine pull requests from README examples #2217
Conversation
@jayaddison could you rebase instead of pushing merge commits into the topic branch? |
Will do on next push; thanks 👍 |
The migration to towncrier in jazzband#2203 included a couple of synthetic change note examples. Now that towncrier is in use and some changes that use it have landed in pip-tools, we can update the examples so that they hyperlink to genuine pull requests. This is intended to aid contributors by providing them with more accurate, representative examples to crib from.
Relates-to commit 1a8cbcc. Closes jazzband#2240
924199c
to
e7e2673
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.
This looks good to me; and 👍 for the fixes to the wrong syntax in those fragments.
I don't have a strong feeling that this tweak is going to help contributors a lot, but it's definitely not going to hurt!
Thanks again @sirosen! |
…elog-entry Add changelog entry for #2217
soupsieve==2.4.1 | ||
# via beautifulsoup4 | ||
sphinx==7.2.2 | ||
sphinx==7.2.6 |
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.
This should've been bumped separately. There's no evidence of Sphinx breaking in CI/RTD: https://app.readthedocs.org/projects/pip-tools/builds/. And it's unrelated.
The migration to towncrier in #2203 included a couple of synthetic change note examples.
Now that
towncrier
is in use and some changes that use itare soon to landhave landed inpip-tools
, we can update the examples so that they hyperlink to genuine pull requests.This is intended to aid contributors by providing them with more accurate, representative examples to crib from.
No changelog needed.
Contributor checklist
Included tests for the changes.A change note is created inor the PR text says "no changelog needed".changelog.d/
(seechangelog.d/README.md
for instructions)Maintainer checklist
skip-changelog
label.Additional fixes
Two problems encountered while testing this are currently resolved by this branch: