[docs] [issue15865] reflect bare star * in function signature documentation

Terry J. Reedy report at bugs.python.org
Fri Sep 7 23:07:54 CEST 2012


Terry J. Reedy added the comment:

By looking at x.py, I confirmed that the added stars are correct.
Also, the correction of 'header' to 'hdr' is correct.

However, for threading.py in 3.3.0, I see

class Thread:
...
    def __init__(self, group=None, target=None, name=None,
                 args=(), kwargs=None, *, daemon=None):

whereas the patch and existing .rst

-.. class:: Thread(group=None, target=None, name=None, args=(), kwargs={},
+.. class:: Thread(group=None, target=None, name=None, args=(), kwargs={}, \
                   verbose=None, *, daemon=None)

has an extra 'verbose=None' that should be removed there and in any explanatory text that follows.

(The fact that we found 2 doc signature errors other than the 4 missing *s suggests that we need a tool to systematically compare doc signature to code signature.)

----------
nosy: +terry.reedy

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


More information about the docs mailing list