-
-
Notifications
You must be signed in to change notification settings - Fork 49
Closed
Labels
help wantedExtra attention is neededExtra attention is needed
Description
In importlib
's documentation:
- Explain what is meant for
ResourceReader
to be "superseded by"TraversableResources
. - Document the
TraversableResources
interface (itsfiles
method). - Explain that
TraversableResources
is a concrete implementation ofResourceReader
, where onlyfiles
is abstract, not an abstract base class as stated. - Under the
resources
heading, demarcate the old (soon to be deprecated) API from the new API and discourage usage of the old API. - Document the
Traversable
interface. This is a particularly pernicious one because without documentation users do not know which attributes of apathlib.Path
object, which is what would be typically returned fromfiles()
, are safe to use, and which methods are safe to call, with which arguments.
Metadata
Metadata
Assignees
Labels
help wantedExtra attention is neededExtra attention is needed