-
-
Notifications
You must be signed in to change notification settings - Fork 47
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.
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
Improving the documentation #240
Comments
Perhaps it could be made clearer, but it is explained.
Yup. This was on my TODO list, I meant to do it earlier this week but it feel down.
This goes into the first point, we could update the description to be clearer.
Yup. I think the docs could use a touch-up. I was meaning to add an API reference section, which would clearly mark the legacy API as deprecated or slated for deprecation, whatever we end up doing. Ideally, the rest of the documentation would only reference this API in the migration sections. I am gonna wait for resolution on #80 to do this.
python/cpython#29039 |
Not sure I understand why that can't be backported to 3.9 and 3.10 if the docs are maintained independently? |
but |
Agh! |
I'd also wait on a call for python/cpython#29036 as that PR is the one that marks the functions as deprecated. |
I realize it's a little awkward having issues in this repo and also bpo, especially for |
Since some work has been done and this issue seems to be languishing, I'm going to go ahead and close it. That said, I'd welcome anyone to re-invigorate the conversation or provide PRs to improve the situation. |
In
importlib
's documentation:ResourceReader
to be "superseded by"TraversableResources
.TraversableResources
interface (itsfiles
method).TraversableResources
is a concrete implementation ofResourceReader
, where onlyfiles
is abstract, not an abstract base class as stated.resources
heading, demarcate the old (soon to be deprecated) API from the new API and discourage usage of the old API.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.The text was updated successfully, but these errors were encountered: