classification
Title: Allow to override a function signature for pydoc with a docstring
Type: enhancement Stage: needs patch
Components: Interpreter Core Versions: Python 3.4
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: eric.araujo, georg.brandl, meador.inge, serhiy.storchaka
Priority: normal Keywords:

Created on 2013-01-02 20:08 by serhiy.storchaka, last changed 2013-01-08 12:27 by eric.araujo.

Messages (3)
msg178846 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2013-01-02 20:08
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?
msg178880 - (view) Author: Meador Inge (meador.inge) * (Python committer) Date: 2013-01-03 01:35
Serhiy, did you mean to mark this as "patch review"?  I don't see a patch.
msg178930 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2013-01-03 10:08
Sorry, I mixed up the issues. For this issue I have not a patch yet. I wait for some suggestions and decisions first.

See also related issue16638.
History
Date User Action Args
2013-01-08 12:27:12eric.araujosetnosy: + eric.araujo
2013-01-03 10:08:59serhiy.storchakasetmessages: + msg178930
stage: patch review -> needs patch
2013-01-03 01:35:51meador.ingesetnosy: + meador.inge
messages: + msg178880
2013-01-02 21:59:39serhiy.storchakasetstage: needs patch -> patch review
2013-01-02 20:08:25serhiy.storchakacreate