[New-bugs-announce] [issue45991] Improve ambiguous docstrings in pkgutil

[Kevin Hock]

New submission from Kevin Hock <khock at pinterest.com>:

# 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

----------
assignee: docs at python
components: Documentation
messages: 407727
nosy: docs at python, khock
priority: normal
severity: normal
status: open
title: Improve ambiguous docstrings in pkgutil
type: enhancement
versions: Python 3.10, Python 3.11, Python 3.6, Python 3.7, Python 3.8, Python 3.9

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue45991>
_______________________________________