Skip to content

bpo-45516: add protocol description to the Traversable documentation #29039

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 4 commits into from
Oct 18, 2021
Merged

bpo-45516: add protocol description to the Traversable documentation #29039

merged 4 commits into from
Oct 18, 2021

Conversation

@FFY00
Copy link
Member

@FFY00 FFY00 commented Oct 18, 2021 •
edited by bedevere-bot
Loading

@FFY00 FFY00 force-pushed the bpo-45516-traversable branch from d0a9fab to 13a6e1c Compare October 18, 2021 19:12
@FFY00 FFY00 requested a review from jaraco October 18, 2021 19:13
@FFY00
Copy link
Member Author

FFY00 commented Oct 18, 2021

We can backport this, right?

jaraco
jaraco reviewed Oct 18, 2021
View reviewed changes
@jaraco
Copy link
Member

jaraco commented Oct 18, 2021

We can backport this, right?

Not exactly. Docs aren't synced between CPython and importlib_resources, so including this additional detail is going to require adding a lot more unsynchronized reference material to importlib_resources. It's probably not worth it. Let's just maintain the reference material here.

jaraco
jaraco reviewed Oct 18, 2021
View reviewed changes
jaraco
jaraco reviewed Oct 18, 2021
View reviewed changes
@FFY00
Copy link
Member Author

FFY00 commented Oct 18, 2021

Sounds good 😊

@FFY00 @jaraco
Update Doc/library/importlib.rst
cd2ef1e 
Co-authored-by: Jason R. Coombs <[email protected]>
@jaraco jaraco merged commit 4d03de3 into python:main Oct 18, 2021
@bedevere-bot
Copy link

bedevere-bot commented Oct 18, 2021

@jaraco: Please replace # with GH- in the commit message next time. Thanks!

@FFY00 FFY00 mentioned this pull request Oct 22, 2021
Closed
@jaraco
Copy link
Member

jaraco commented Oct 31, 2021

We can backport this, right?

Not exactly. Docs aren't synced between CPython and importlib_resources, so including this additional detail is going to require adding a lot more unsynchronized reference material to importlib_resources. It's probably not worth it. Let's just maintain the reference material here.

Wait. Did you mean backport to importlib_resources or backport to Python 3.10/3.9? If the latter, then probably yes.

@FFY00
Copy link
Member Author

FFY00 commented Oct 31, 2021 •
edited
Loading

The later, I wasn't sure since you maintain a cpython branch.

@miss-islington
Copy link
Contributor

miss-islington commented Oct 31, 2021

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

@miss-islington
Copy link
Contributor

miss-islington commented Oct 31, 2021

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 31, 2021
@FFY00 @miss-islington
bpo-45516: add protocol description to the Traversable documentation (p…
7d5992e 
…ythonGH-29039)

* bpo-45516: add protocol description to the Traversable documentation

Signed-off-by: Filipe Laíns <[email protected]>

* Update Doc/library/importlib.rst

Co-authored-by: Jason R. Coombs <[email protected]>

* Update Lib/importlib/abc.py

* Update Doc/library/importlib.rst

Co-authored-by: Jason R. Coombs <[email protected]>

Co-authored-by: Jason R. Coombs <[email protected]>
(cherry picked from commit 4d03de3)

Co-authored-by: Filipe Laíns <[email protected]>
@bedevere-bot
Copy link

bedevere-bot commented Oct 31, 2021

GH-29348 is a backport of this pull request to the 3.9 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 31, 2021
@FFY00 @miss-islington
bpo-45516: add protocol description to the Traversable documentation (p…
8f0acf7 
…ythonGH-29039)

* bpo-45516: add protocol description to the Traversable documentation

Signed-off-by: Filipe Laíns <[email protected]>

* Update Doc/library/importlib.rst

Co-authored-by: Jason R. Coombs <[email protected]>

* Update Lib/importlib/abc.py

* Update Doc/library/importlib.rst

Co-authored-by: Jason R. Coombs <[email protected]>

Co-authored-by: Jason R. Coombs <[email protected]>
(cherry picked from commit 4d03de3)

Co-authored-by: Filipe Laíns <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 31, 2021
@bedevere-bot
Copy link

bedevere-bot commented Oct 31, 2021

GH-29349 is a backport of this pull request to the 3.10 branch.

miss-islington added a commit that referenced this pull request Oct 31, 2021
@miss-islington @FFY00
bpo-45516: add protocol description to the Traversable documentation (G…
89b1237 
…H-29039)

* bpo-45516: add protocol description to the Traversable documentation

Signed-off-by: Filipe Laíns <[email protected]>

* Update Doc/library/importlib.rst

Co-authored-by: Jason R. Coombs <[email protected]>

* Update Lib/importlib/abc.py

* Update Doc/library/importlib.rst

Co-authored-by: Jason R. Coombs <[email protected]>

Co-authored-by: Jason R. Coombs <[email protected]>
(cherry picked from commit 4d03de3)

Co-authored-by: Filipe Laíns <[email protected]>
miss-islington added a commit that referenced this pull request Oct 31, 2021
@miss-islington @FFY00
bpo-45516: add protocol description to the Traversable documentation (G…
b04b307 
…H-29039)

* bpo-45516: add protocol description to the Traversable documentation

Signed-off-by: Filipe Laíns <[email protected]>

* Update Doc/library/importlib.rst

Co-authored-by: Jason R. Coombs <[email protected]>

* Update Lib/importlib/abc.py

* Update Doc/library/importlib.rst

Co-authored-by: Jason R. Coombs <[email protected]>

Co-authored-by: Jason R. Coombs <[email protected]>
(cherry picked from commit 4d03de3)

Co-authored-by: Filipe Laíns <[email protected]>
@FFY00 FFY00 mentioned this pull request Apr 10, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jaraco jaraco jaraco approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@FFY00 @jaraco @bedevere-bot @miss-islington @the-knights-who-say-ni