classification
Title: Document C docstring behavior
Type: enhancement Stage: patch review
Components: Documentation Versions:
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, jameshcorbett
Priority: normal Keywords: patch

Created on 2020-07-29 00:00 by jameshcorbett, last changed 2020-07-29 01:25 by jameshcorbett.

Pull Requests
URL Status Linked Edit
PR 21673 open jameshcorbett, 2020-07-29 01:25
Messages (1)
msg374547 - (view) Author: James Corbett (jameshcorbett) * Date: 2020-07-29 00:00
As described in https://stackoverflow.com/questions/25847035/what-are-signature-and-text-signature-used-for-in-python-3-4, https://bugs.python.org/issue20586, and https://stackoverflow.com/questions/50537407/add-a-signature-with-annotations-to-extension-methods,  it is possible to embed a signature in docstrings for C functions, so that `help` and `inspect.signature` work properly on them. However, this functionality isn't documented anywhere. I think something should be added to the "extending and embedding the Python interpreter" tutorial.
History
Date User Action Args
2020-07-29 01:25:49jameshcorbettsetkeywords: + patch
stage: patch review
pull_requests: + pull_request20816
2020-07-29 00:00:19jameshcorbettcreate