[docs] [issue14804] Wrong defaults args notation in docs

Ezio Melotti report at bugs.python.org
Mon May 14 11:56:45 CEST 2012


Ezio Melotti <ezio.melotti at gmail.com> added the comment:

The patch looks good to me, however in

-.. method:: epoll.poll([timeout=-1[, maxevents=-1]])
+.. method:: epoll.poll(timeout=-1, maxevents=-1)

it seems that maxevents can be passed only if timeout is specified, and this information is now lost in the signature.  If this is indeed true, it should be written down in the doc.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue14804>
_______________________________________


More information about the docs mailing list