Make package README links portable - #44
Merged
Merged
Conversation
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
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.
Why
README.mdis the package long description. Its repository-relative links work on GitHub but would point to nonexistent paths when rendered on PyPI. The examples guide also still linked to the removed#installheading.Reviewer decision: confirm that the package page should link to the canonical documentation on
mainwhile releases remain pre-alpha.What changed
This does not publish a package, change runtime behavior, or modify an existing release.
Verification
python -m pytest -q: 762 passed, 4 skipped; 765 subtests passed.python benchmarks/run_offline.py: 16 passed.python scripts/check_docs.py: 48 Markdown files passed.python scripts/check_quickstart.py: demo, Doctor, reduction, validation, and 2/2 replay passed.python -m twine check <wheel> <sdist>: both passed.python scripts/check_release_artifacts.py --tag v0.1.0.dev11 <wheel> <sdist>: valid.Disclosure