changeset 89:102bdfba3518

better sourcecode template
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Mon, 07 Mar 2011 19:31:25 +0100
parents 6fed0c3c3bad
children 21483835402f
files MoinMoin/_template.py
diffstat 1 files changed, 9 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/MoinMoin/_template.py	Mon Mar 07 19:15:53 2011 +0100
+++ b/MoinMoin/_template.py	Mon Mar 07 19:31:25 2011 +0100
@@ -2,9 +2,16 @@
 # License: GNU GPL v2 (or any later version), see LICENSE.txt for details.
 
 """
-MoinMoin - <short description>
+MoinMoin - sourcecode header template
 
-<what this stuff does ... - verbose enough>
+Please use this template when starting a new python source file.
+
+It is important that all sourcecode files have the same header structure,
+are correctly copyrighted and licensed and have a reasonable docstring
+explaining what the module / package does.
+
+Of course you'll have to edit/fix the Copyright line and also the docstring
+needs to be replaced with something making sense, but keep the structure.
 """