[docs] [issue14783] Make int() and str() docstrings correct
report at bugs.python.org
Sat Sep 1 11:30:08 CEST 2012
Ezio Melotti added the comment:
The issues about "weird" signatures are being discussed on #15831.
> However, this issue is about the docstring. Leave it incorrect?
> Change it to the hard-to-parse one liner? Change it to a
> two-line signature also?
For the docstring it's ok to use the double signature too. The description, while not too comprehensive, is understandable.
The description of int() in the docs is instead a bit complicated. The content is good, but IMHO it would be more understandable if it was broken down into paragraphs or into a list.
Python tracker <report at bugs.python.org>
More information about the docs