[Python-Dev] Best practice for documentation for std lib (original) (raw)
Antoine Pitrou solipsis at pitrou.net
Mon Sep 23 16:07:45 CEST 2013
- Previous message: [Python-Dev] Best practice for documentation for std lib
- Next message: [Python-Dev] Best practice for documentation for std lib
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
Le Mon, 23 Sep 2013 15:51:27 +0200, Walter Dörwald <walter at livinglogic.de> a écrit :
On 23.09.13 15:38, Fred Drake wrote:
> On Mon, Sep 23, 2013 at 7:27 AM, Walter Dörwald > <walter at livinglogic.de> wrote: >> It would be great if the docstring contained a link to the online >> documentation. > > The docstring itself, or the presentation generated by help() ? The presentation generated by help(), or the output of IPython's foo? or foo?? syntax.
Perhaps objects could gain some kind of optional docurl attribute, to avoid cluttering doc with external links. Not sure how that could be auto-generated, though (we certainly don't want to maintain doc links manually).
Regards
Antoine.
- Previous message: [Python-Dev] Best practice for documentation for std lib
- Next message: [Python-Dev] Best practice for documentation for std lib
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]