classification
Title: Improve ambiguous docstrings in pkgutil
Type: enhancement Stage:
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, khock
Priority: normal Keywords: easy

Created on 2021-12-05 18:56 by khock, last changed 2022-01-14 11:49 by iritkatriel.

Messages (1)
msg407727 - (view) Author: Kevin Hock (khock) Date: 2021-12-05 18:56
# Issue

If you search for "list of paths" in https://github.com/KevinHock/cpython/blob/main/Lib/pkgutil.py

A lot of people mistake this as `PosixPath`. You can see an example here: https://github.com/duo-labs/parliament/pull/207 that references other OSS repositories.

# Solution

We can
- Change the wording. e.g. "list of strings of the paths" or some variation of that.

and perhaps additionally

- Throw a ValueError similar to: https://github.com/python/cpython/blob/628abe4463ed40cd54ca952a2b4cc2d6e74073f7/Lib/pkgutil.py#L122
History
Date User Action Args
2022-01-14 11:49:08iritkatrielsetkeywords: + easy
versions: - Python 3.6, Python 3.7, Python 3.8
2021-12-05 18:56:47khockcreate