8000 gh-102215: importlib documentation cleanups by yrro · Pull Request #102217 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-102215: importlib documentation cleanups #102217

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
Merged
merged 5 commits into from
May 6, 2023
Merged

gh-102215: importlib documentation cleanups #102217

merged 5 commits into from
May 6, 2023

Conversation

yrro
Copy link
Contributor
@yrro yrro commented Feb 24, 2023 •
edited by bedevere-bot
Loading

Fixes a heading at the wrong level, headings in the wrong format, and undescriptive module synopses.

@bedevere-bot bedevere-bot mentioned this pull request Feb 24, 2023
Closed
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news labels Feb 24, 2023
@ghost
Copy link
ghost commented Feb 24, 2023 •
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

yrro added 4 commits February 24, 2023 16:28
@yrro
pythongh-102215: Fix headling level in importlib.resources
c257982
@yrro
importlib.resources: bring section heading format in-line with that o…
1636c32 
…f other modules

Synopsis is also updated to match.
@yrro
importlib.metadata: refer to the module by its importable name
b5cbe0f 
Previously the module was referenced by the name of the package that
backports it to older python versions.
@yrro
importlib.resources: use synopsis in module heading
2bebc2d 
The synopsis provides a much better and quite succinct explanation of
the purpose of the module.
@yrro yrro force-pushed the importlib-cleanups branch from 31a309e to 2bebc2d Compare February 24, 2023 16:28
@sobolevn sobolevn requested a review from jaraco February 25, 2023 05:25
FFY00
FFY00 reviewed May 5, 2023
View reviewed changes
FFY00
FFY00 approved these changes May 6, 2023
View reviewed changes
Copy link
Member
@FFY00 FFY00 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@FFY00
Copy link
Member
FFY00 commented May 6, 2023

The readthedocs failure seems unrelated, so I am gonna go ahead and merge. Thank you for the contribution 😊

@FFY00 FFY00 merged commit 4cd95dc into python:main May 6, 2023
@AA-Turner AA-Turner mentioned this pull request Aug 16, 2023
Closed
@AA-Turner AA-Turner added the needs backport to 3.11 only security fixes label Aug 16, 2023
@miss-islington
Copy link
Contributor

Thanks @yrro for the PR, and @FFY00 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@AA-Turner AA-Turner added needs backport to 3.11 only security fixes and removed needs backport to 3.11 only security fixes labels Aug 16, 2023
@miss-islington
Copy link
Contributor

Thanks @yrro for the PR, and @FFY00 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@Mariatta Mariatta added needs backport to 3.11 only security fixes and removed needs backport to 3.11 only security fixes labels Aug 16, 2023
@miss-islington
Copy link
Contributor

Thanks @yrro for the PR, and @FFY00 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@AA-Turner AA-Turner added needs backport to 3.11 only security fixes and removed needs backport to 3.11 only security fixes labels Aug 16, 2023
@miss-islington
Copy link
Contributor

Thanks @yrro for the PR, and @FFY00 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

jaraco
jaraco reviewed Aug 17, 2023
View reviewed changes
@jaraco jaraco mentioned this pull request Aug 17, 2023
Closed
@AA-Turner AA-Turner mentioned this pull request Jan 30, 2025
Open
@hugovk hugovk removed the needs backport to 3.11 only security fixes label Feb 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jaraco jaraco jaraco left review comments

@brettcannon brettcannon brettcannon approved these changes

@FFY00 FFY00 FFY00 approved these changes

@encukou encukou Awaiting requested review from encukou

@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently 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 news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@yrro @FFY00 @miss-islington @brettcannon @jaraco @hugovk @Mariatta @AA-Turner @bedevere-bot
0