[Python-Dev] How to document functions with optional positional parameters?

Victor Stinner victor.stinner at gmail.com
Sat Mar 21 12:03:02 CET 2015


Le samedi 21 mars 2015, Serhiy Storchaka <storchaka at gmail.com> a écrit :


>
> For example binascii.crc32(). It has two positional parameters, one is
mandatory, and one is optional with default value 0. With Argument Clinic
its signature is crc32(data, crc=0, /).

 The \ is useful, it indicates that you cannot use keywords. If you want to
drop \, modify the function to accept keywords.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-dev/attachments/20150321/4a8df146/attachment.html>


More information about the Python-Dev mailing list