Skip to content

gh-150887: Fix Traversable abstractmethod docs#150918

Open
iamrajhans wants to merge 2 commits into
python:mainfrom
iamrajhans:issue-150887-importlib-docs
Open

gh-150887: Fix Traversable abstractmethod docs#150918
iamrajhans wants to merge 2 commits into
python:mainfrom
iamrajhans:issue-150887-importlib-docs

Conversation

@iamrajhans
Copy link
Copy Markdown
Contributor

Remove stale abstractmethod markers from importlib.resources.abc.Traversable.joinpath and truediv docs. These methods have concrete implementations.\n\nFixes gh-150887.

@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented Jun 4, 2026

Documentation build overview

📚 cpython-previews | 🛠️ Build #33001880 | 📁 Comparing b4f1c2c against main (a96cba5)

  🔍 Preview build  

3 files changed
± library/importlib.resources.abc.html
± using/windows.html
± whatsnew/changelog.html

@Andrew5057
Copy link
Copy Markdown
Contributor

From a comment on the issue:

The implications of this in the context of a protocol are too subtle for me to feel up to proposing actual documentation text.

One option is just to not provide any doc text; the protocol inheritance semantics have more to do with protocols in general than this particular one. Alternatively, a prefix along the lines of "For classes that explicitly subclass Traversable, the default implementation..." might be sufficient?

The relevant spec is in the typing docs, though linking that might be overkill.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants