Where is the most common place that you people put module docstrings in your source code files?
Is it right after the shebang line and before the copyright notice, or perhaps after the copyright notice and before imports?
Thanks.
Where is the most common place that you people put module docstrings in your source code files?
Is it right after the shebang line and before the copyright notice, or perhaps after the copyright notice and before imports?
Thanks.
Quote from above:
Werner
On 09/08/2013 13:13, Boštjan Mejak
wrote:
Where is the most common place that you people put
module docstrings in your source code files?
Is it right after the shebang line and before the copyright
notice, or perhaps after the copyright notice and before
imports?
http://www.python.org/dev/peps/pep-0257/
Docstring?](PEP 257 – Docstring Conventions | peps.python.org)
A docstring is a string literal that occurs as the first
statement in
a module, function, class, or method definition. Such a docstring
becomes the __doc__
special
attribute of that object.
Following might also be interesting/useful.
http://www.python.org/dev/peps/pep-0008/#documentation-strings
http://wxpython.org/Phoenix/docs/html/DocstringsGuidelines.html
http://sphinx-doc.org/ext/autodoc.html