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

Fred L. Drake, Jr. fdrake at acm.org
Mon Jul 25 15:54:10 CEST 2005


On Sunday 24 July 2005 19:24, Martin Blais wrote:
 > 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.

Yes, it does.  Avoiding the maintenance burden is a matter of having only one 
source for the docs, and doesn't not inform the selection of which place is 
best in a substantial way.  A little though.


  -Fred

-- 
Fred L. Drake, Jr.   <fdrake at acm.org>


More information about the Python-Dev mailing list