gh-89679: improve TraversableResources's documentation #29174
+9
−6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
a960d23 to
3df59ff
Compare
|
@layday do you have any suggestions? |
Signed-off-by: Filipe Laíns <lains@riseup.net>
3df59ff to
a9815ee
Compare
|
I'd reword this completely - it's far too verbose and fails to get the message across: An abstract base class implementing :class:`importlib.abc.ResourceReader`
for :class:`importlib.abc.Traversable` objects, and defining one
abstract method, :meth:`files`, which must return such an object.
Loaders are expected to implement this ABC for resource reading,
instead of implementing :class:`importlib.abc.ResourceReader` directly,
to interface with :meth:`importlib.resources.files`.Document the .. abstractmethod:: files()
An abstract method to return a :class:`importlib.abc.Traversable`
instance for the package's resources.Drag the |
|
https://bugs.python.org/issue45516 is closed. What is the status of this PR? |
|
Hi @iritkatriel, it is still relevant, but I am not sure if I will pick this up again soon. |
|
Ok, I reopened the issue on GitHub. |
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.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This was my attempt at rewriting
TraversableResourcesdescription to make it a bit clearer to people who are not familiar with the other protocols. I don't think I did a great job, but hopefully is a bit better.Does anyone have any suggestions on how to improve this?
https://bugs.python.org/issue45516