Doc strings for a standalone app??

Peter Hansen peter at
Thu Jun 10 15:48:42 CEST 2004

j_mckitrick wrote:

> It SEEMS to me that doc strings are for those who will USE your code,
> and comments for those who will MAINTAIN it.  Does that make any
> sense?

That makes total sense.  I never even considered using doc-strings
for anything but API type information.  I'm not sure why... perhaps
because that's how they are used in all the standard library code,
or perhaps just because it doesn't seem to make any sense having
maintenance-related information available in the module at runtime.

I suppose if they had been intended for maintenance info, they
would have been called "comment strings", and not "doc strings"...


More information about the Python-list mailing list