[issue41430] Document C docstring behavior

James Corbett report at bugs.python.org
Tue Jul 28 20:00:19 EDT 2020


New submission from James Corbett <james.h.corbett at gmail.com>:

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.

----------
assignee: docs at python
components: Documentation
messages: 374547
nosy: docs at python, jameshcorbett
priority: normal
severity: normal
status: open
title: Document C docstring behavior
type: enhancement

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


More information about the Python-bugs-list mailing list