[New-bugs-announce] [issue20530] Change the text signature format (again) to be more robust

Larry Hastings report at bugs.python.org
Thu Feb 6 15:09:10 CET 2014


New submission from Larry Hastings:

Following a new discussion of the format of the text signature, I decided to go with this:
    <name-of-function>(...)\n--\n\n

See here for the discussion:
   https://mail.python.org/pipermail/python-dev/2014-February/132271.html

Patch attached implementing this approach.  Can I get a review?  I want this in before tagging for rc1 on Saturday.

Other changes:

* clinic.py now generates the "/" marker in sigantures to denote
  positional-only parameters.

* clinic.py --make is a lot faster; it prescans the file for any
  clinic block signatures, and if it doesn't see any it skips the file.

* When generating the docstring for a function with optional groups,
  the signature generated is not intended to be machine-readable.
  So it omits the "$", the "/", and the "--" markers.  (See
  Modules/_cursesmodule.c for the one and only example.)

----------
assignee: larry
files: larry.even.newerer.signature.syntax.1.diff
keywords: patch
messages: 210380
nosy: georg.brandl, larry, ncoghlan, serhiy.storchaka, yselivanov, zach.ware
priority: release blocker
severity: normal
stage: patch review
status: open
title: Change the text signature format (again) to be more robust
type: enhancement
versions: Python 3.4
Added file: http://bugs.python.org/file33941/larry.even.newerer.signature.syntax.1.diff

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


More information about the New-bugs-announce mailing list