RetroSearch Browse

Mon Jul 25 01:24:51 CEST 2005 · https://mail.python.org/pipermail/python-dev/2005-July/054935.html

On 7/24/05, Fred L. Drake, Jr. <fdrake at acm.org> wrote:
> On Sunday 24 July 2005 09:34, skip at pobox.com wrote:
>  > detailed as the full documentation?  I'm inclined to think that while it
>  > might be a noble goal, it's probably not worth the effort for several
>  > reasons.
> 
> All your reasons not to include all the documentation in the docstrings are
> good.  I'll add:
> 
>     5. It would be a maintenance problem keeping the two sets of docs in sync.

This ties well with the discussion on Doc-SIG a few months ago about
manual docs vs. in-code docs.   If a system could be devised to "pull"
the docstrings into the manual (at appropriate places), the issue of
syncing the docs partially goes away.

cheers,

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://mail.python.org/pipermail/python-dev/2005-July/054935.html below:

[Python-Dev] should doc string content == documentation content?