[docs] [issue32301] Typo in array documentation

Steven D'Aprano report at bugs.python.org
Wed Dec 13 06:06:50 EST 2017


Steven D'Aprano <steve+python at pearwood.info> added the comment:

The given version is correct: the comma is only required if the initializer is given. Your suggested version 

    typecode, [initializer]

implies that the comma is always required whether the initializer is given or not.

If we want to be absolutely pedantic, we could write:

    .. class:: array(typecode[, [initializer]])

as trailing commas are legal in function calls. But I don't think that makes for good documentation.

----------
nosy: +steven.daprano
resolution:  -> rejected
stage:  -> resolved
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue32301>
_______________________________________


More information about the docs mailing list