New submission from Petr Viktorin <encu...@gmail.com>: importlib.resources.files is documented [0] as returning importlib.resources.abc.Traversable, which is an undocumented class (dead link) now. It should be documented. The [source] has helpful docstrings, but is missing some details. I'd like to know these before writing some docs:
- Can the argument to `joinpath` contain path separators? - Are the methods expected to raise specific exception types (e.g. if a resource is missing, or you call iterdir on a “file”)? This seems quite important for people who implement the protocol. [0]: https://docs.python.org/dev/library/importlib.resources.html#importlib.resources.files [source]: https://github.com/python/cpython/blob/main/Lib/importlib/resources/abc.py#L49 ---------- assignee: docs@python components: Documentation messages: 416164 nosy: docs@python, jaraco, petr.viktorin priority: normal severity: normal status: open title: Document importlib.resources.abc.Traversable _______________________________________ Python tracker <rep...@bugs.python.org> <https://bugs.python.org/issue47142> _______________________________________ _______________________________________________ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
