[Python-Dev] docstring before function declaration

Greg Ewing greg.ewing at canterbury.ac.nz
Tue Mar 22 01:39:29 CET 2005

Nicholas Jacobson wrote:
> If a programmer wanted a docstring for the function
> but not the module, a blank first line would do the
> trick.  A docstring for the module but not the
> function?  Put a blank line between the module's
> docstring and the function.

-1 on all this making of blank lines significant.

Currently I can leave some space before/after a
docstring without breaking anything. This can
help readability, especially for class docstrings.

Greg Ewing, Computer Science Dept, +--------------------------------------+
University of Canterbury,	   | A citizen of NewZealandCorp, a	  |
Christchurch, New Zealand	   | wholly-owned subsidiary of USA Inc.  |
greg.ewing at canterbury.ac.nz	   +--------------------------------------+

More information about the Python-Dev mailing list