v0.11.4: absolute README links for the PyPI page - #30
Merged
Conversation
The README is rendered as the package long description on PyPI, where relative links don't resolve. Point the examples/ and CONTRIBUTING.md links at absolute GitHub URLs so the PyPI page shows working links. twine check passes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
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.
Pre-publish readiness check:
twine checkpasses on the built sdist + wheel, metadata and all Project-URLs are complete, and the description content-type istext/markdown. The one thing twine can't catch is that the README's relative links render as broken on the PyPI project page (the README is shown standalone there as the long description).Fixed the two relative links —
examples/andCONTRIBUTING.md— to absolute GitHub URLs so they work on both GitHub and PyPI. No other README references are relative, and there are no embedded images to break.This de-risks the eventual PyPI publish so the project page renders cleanly on first upload.
🤖 Generated with Claude Code