[docs] [issue34369] kqueue.control() documentation and implementation mismatch

Martin Panter report at bugs.python.org
Sat Aug 11 20:21:28 EDT 2018

Martin Panter <vadmium+py at gmail.com> added the comment:

I think this was an attempt to specify a positional-only parameter (by using square brackets), and include a default value in the signature. The usual approach in this situation is to use square brackets, but only mention the default value in the text:

control(changelist, max_events[, timeout])
. . .
The default for "timeout" is None, to wait forever.

In Issue 13386 Ezio suggested against showing both square brackets and a default value, and I agree.

Berker: your "select" and "poll" cases all include the PEP 457 slash "/" notation, which was supposed to indicate positional-only parameters. See Issue 21314 about explaining this notation in the documentation somewhere.

assignee:  -> docs at python
components: +Documentation -Library (Lib)
nosy: +docs at python, martin.panter
versions: +Python 2.7

Python tracker <report at bugs.python.org>

More information about the docs mailing list