Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Docs: fix markup for importlib.machinery.NamespaceLoader #112479

Merged
merged 1 commit into from
Nov 28, 2023
Merged

Docs: fix markup for importlib.machinery.NamespaceLoader #112479

merged 1 commit into from
Nov 28, 2023

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Nov 28, 2023 •
edited by github-actions bot
Loading

The markup for this class is incorrect, leading it to be rendered incorrectly by Sphinx, and meaning that there's no anchor on the HTML webpage that you can link to.

📚 Documentation preview 📚: https://cpython-previews--112479.org.readthedocs.build/

@bedevere-app bedevere-app bot added the docs Documentation in the Doc dir label Nov 28, 2023
@AlexWaygood
Copy link
Member Author

Currently:

[I cannot link to it because the markup is wrong, so Sphinx is not adding an anchor]

Screenshot

image

With this PR:

Docs preview: https://cpython-previews--112479.org.readthedocs.build/en/112479/library/importlib.html#importlib.machinery.NamespaceLoader

Screenshot

image

@AlexWaygood AlexWaygood requested a review from hugovk November 28, 2023 00:09
@AlexWaygood AlexWaygood marked this pull request as ready for review November 28, 2023 00:09
ericsnowcurrently
ericsnowcurrently approved these changes Nov 28, 2023
View reviewed changes
Copy link
Member

@ericsnowcurrently ericsnowcurrently left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@AlexWaygood AlexWaygood merged commit 2e632fa into python:main Nov 28, 2023
@AlexWaygood AlexWaygood deleted the namespaceloader-docs branch November 28, 2023 00:15
@miss-islington-app
Copy link

Thanks @AlexWaygood for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 28, 2023
@AlexWaygood @miss-islington
Docs: fix markup for importlib.machinery.NamespaceLoader (pythonGH-…
ec5b4b4 
…112479)

(cherry picked from commit 2e632fa)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Nov 28, 2023

GH-112481 is a backport of this pull request to the 3.12 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 28, 2023
@AlexWaygood @miss-islington
Docs: fix markup for importlib.machinery.NamespaceLoader (pythonGH-…
aefdf07 
…112479)

(cherry picked from commit 2e632fa)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Nov 28, 2023
@bedevere-app
Copy link

bedevere-app bot commented Nov 28, 2023

GH-112482 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Nov 28, 2023
AlexWaygood added a commit that referenced this pull request Nov 28, 2023
@miss-islington @AlexWaygood
[3.11] Docs: fix markup for importlib.machinery.NamespaceLoader (GH…
b85070c 
…-112479) (#112482)

Docs: fix markup for `importlib.machinery.NamespaceLoader` (GH-112479)
(cherry picked from commit 2e632fa)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this pull request Nov 28, 2023
@miss-islington @AlexWaygood
[3.12] Docs: fix markup for importlib.machinery.NamespaceLoader (GH…
c44af75 
…-112479) (#112481)

Docs: fix markup for `importlib.machinery.NamespaceLoader` (GH-112479)
(cherry picked from commit 2e632fa)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@AlexWaygood @aisk
Docs: fix markup for importlib.machinery.NamespaceLoader (python#11…
55bf3ec 
…2479)
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@AlexWaygood @Glyphack
Docs: fix markup for importlib.machinery.NamespaceLoader (python#11…
94a8807 
…2479)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ericsnowcurrently ericsnowcurrently ericsnowcurrently approved these changes

@hugovk hugovk Awaiting requested review from hugovk

@brettcannon brettcannon Awaiting requested review from brettcannon brettcannon is a code owner

@ncoghlan ncoghlan Awaiting requested review from ncoghlan ncoghlan is a code owner

@warsaw warsaw Awaiting requested review from warsaw warsaw is a code owner

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AlexWaygood @ericsnowcurrently