Message 374547 - Python tracker

➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author	jameshcorbett
Recipients	docs@python, jameshcorbett
Date	2020-07-29.00:00:19
SpamBayes Score	-1.0
Marked as misclassified	Yes
Message-id	<1595980819.55.0.541837599725.issue41430@roundup.psfhosted.org>
In-reply-to

Content
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.

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 00:00:19	jameshcorbett	set	recipients: + jameshcorbett, docs@python
2020-07-29 00:00:19	jameshcorbett	set	messageid: <1595980819.55.0.541837599725.issue41430@roundup.psfhosted.org>
2020-07-29 00:00:19	jameshcorbett	link	issue41430 messages
2020-07-29 00:00:19	jameshcorbett	create