Changes between Version 35 and Version 36 of Submitting/Python

Timestamp:

Jan 18, 2022, 1:57:27 PM (2 years ago)

Author:

wenzeslaus

Comment:

Update how file header is structured

Submitting/Python

@@ -23 +23 @@
 general over view of the code in the file to assist other
 programmers that will need to make changes to your code. For this
-purpose use [https://www.python.org/dev/peps/pep-0257/ Python Docstring].
+purpose use a comment and [https://www.python.org/dev/peps/pep-0257/ Python docstring].
 
 Example (fictitious header for a script called ''g.myscript''):
 
 {{{
-#!python
-"""
-MODULE:    g.myscript
-
-AUTHOR(S): John Doe <email AT some domain>
-
-PURPOSE:   Describe your script here...
-
-COPYRIGHT: (C) 2007 John Doe, and by the GRASS Development Team
-
-           This program is free software under the GNU General Public
-           License (>=v2). Read the file COPYING that comes with GRASS
-           for details.
-"""
+#!/usr/bin/env python
+
+##############################################################################
+# MODULE:    g.myscript
+#
+# AUTHOR(S): John Doe <email AT some domain>
+#
+# PURPOSE:   Describe your script here from maintainer perspective
+#
+# COPYRIGHT: (C) 2022 John Doe, and by the GRASS Development Team
+#
+#            This program is free software under the GNU General Public
+#            License (>=v2). Read the file COPYING that comes with GRASS
+#            for details.
+##############################################################################
+
+"""Describe your script here from Python user perspective"""
 }}}