[issue41430] Document C docstring behavior

[James Corbett]

Change by James Corbett :


--
keywords: +patch
pull_requests: +20816
stage:  -> patch review
pull_request: https://github.com/python/cpython/pull/21673

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41430] Document C docstring behavior

[James Corbett]

New submission from James Corbett :

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@python
components: Documentation
messages: 374547
nosy: docs@python, jameshcorbett
priority: normal
severity: normal
status: open
title: Document C docstring behavior
type: enhancement

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com