Martin Panter <> 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@python
components: +Documentation -Library (Lib)
nosy: +docs@python, martin.panter
versions: +Python 2.7

Python tracker <>
Python-bugs-list mailing list

Reply via email to