24 Jul
2005
24 Jul
'05
11:24 p.m.
On 7/24/05, Fred L. Drake, Jr.
On Sunday 24 July 2005 09:34, skip@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,