-
-
Notifications
You must be signed in to change notification settings - Fork 50
Closed
Labels
help wantedExtra attention is neededExtra attention is needed
Description
In importlib's documentation:
- Explain what is meant for
ResourceReaderto be "superseded by"TraversableResources. - Document the
TraversableResourcesinterface (itsfilesmethod). - Explain that
TraversableResourcesis a concrete implementation ofResourceReader, where onlyfilesis abstract, not an abstract base class as stated. - Under the
resourcesheading, demarcate the old (soon to be deprecated) API from the new API and discourage usage of the old API. - Document the
Traversableinterface. This is a particularly pernicious one because without documentation users do not know which attributes of apathlib.Pathobject, 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