[New-bugs-announce] [issue16842] Allow to override a function signature for pydoc with a docstring

[Serhiy Storchaka]

New submission from Serhiy Storchaka:

Just a quote of Georg Brandl's msg178519:

> A simple, minimal-invasive solution would be to allow a signature for documentation purposes as the first line of the docstrings.
>
> pydoc could recognize this (if docstring.startswith(func.__name__ + '(') or something like that), and display the given signature instead of the introspected one.

I see only one obstacle. Some functions (like dict.update()) needs several signatures. How detect and format them?

----------
components: Interpreter Core
messages: 178846
nosy: georg.brandl, serhiy.storchaka
priority: normal
severity: normal
stage: needs patch
status: open
title: Allow to override a function signature for pydoc with a docstring
type: enhancement
versions: Python 3.4

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