Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.
Sign upreplaced links in importlib.metadata.rst with sphinx roles #17730
+19
−23
Conversation
The importlib.metadata documentation uses hardcoded links to internal pages. This results in minor rendering issues. This change replaces the hardcoded links with suitable Sphinx roles. Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
This comment has been minimized.
This comment has been minimized.
|
Dear reviewers, I did create neither an issue on BPO nor a news entry as the fix is IMO a trivial one. |
This comment has been minimized.
This comment has been minimized.
|
cc: @jaraco |
This comment has been minimized.
This comment has been minimized.
|
Thanks for this. I agree the changes are beneficial. I need to figure out how these changes reconcile with the back port. I don’t think these Sphinx roles exist in the Sphinx environment in which the backport docs render. It might be time, however, to defer all significant docs to CPython (and remove them from the backport). Is that something you would like to help with? |
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.
hoefling commentedDec 28, 2019
The importlib.metadata documentation uses hardcoded links to internal
pages. This results in minor rendering issues. This change replaces
the hardcoded links with suitable Sphinx roles.
Signed-off-by: Oleg Höfling oleg.hoefling@gmail.com