docs: make the README's links absolute for PyPI - #2
Merged
Conversation
PyPI renders the README as the project page and does not rewrite relative links: [CONTRIBUTING.md](CONTRIBUTING.md) would resolve against pypi.org and 404. Both now point at the files on GitHub, which is correct from either page.
github-actions
Bot
added
the
docs
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
1 participant
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.
Found while validating the distributions before the first release.
PyPI renders the README as the project page and does not rewrite relative links, so
[CONTRIBUTING.md](CONTRIBUTING.md)and[MIT License](LICENSE)would resolve againstpypi.org/project/picklock/and 404 for anyone arriving from there. Absolute GitHub URLs are correct from both pages.Verified alongside it, with a current twine in a throwaway venv:
twine checkpasses on both artifacts (the local failure was twine 6.2.0 not knowing Metadata-Version 2.5; CI uses 7.0.0, which does).picklock --versionruns.py.typedonly — no tests, docs or scripts — and embeds LICENSE.