[gtk-doc] python: format top comment as doc string.



commit 2ad7764aa861dc56edaa3f65a101fb04931f684d
Author: Stefan Sauer <ensonic users sf net>
Date:   Wed Apr 5 20:35:06 2017 +0200

    python: format top comment as doc string.

 gtkdoc/check.py    |   11 +++++------
 gtkdoc/rebase.py   |    7 +++----
 gtkdoc/scangobj.py |   11 +++++------
 3 files changed, 13 insertions(+), 16 deletions(-)
---
diff --git a/gtkdoc/check.py b/gtkdoc/check.py
index 8acf5d0..14a3bc3 100755
--- a/gtkdoc/check.py
+++ b/gtkdoc/check.py
@@ -19,12 +19,11 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 #
 
-#
-# Script      : gtkdoc-check
-# Description : Runs various checks on built documentation and outputs test
-#                results. Can be run druring make check, by adding this to the
-#                documentations Makefile.am: TESTS = $(GTKDOC_CHECK)
-#
+"""
+The check tool runs various tests on built documentation and outputs test
+results. Can be run druring make check, by adding this to the documentations
+Makefile.am: TESTS = $(GTKDOC_CHECK).
+"""
 
 # Support both Python 2 and 3
 from __future__ import print_function
diff --git a/gtkdoc/rebase.py b/gtkdoc/rebase.py
index a5ff41e..e09bb8e 100755
--- a/gtkdoc/rebase.py
+++ b/gtkdoc/rebase.py
@@ -21,10 +21,9 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 #
 
-#
-# Script      : gtkdoc-rebase
-# Description : Rebases URI references in installed HTML documentation.
-#
+"""
+The rebase tool rewrites URI references in installed HTML documentation.
+"""
 
 from __future__ import print_function
 
diff --git a/gtkdoc/scangobj.py b/gtkdoc/scangobj.py
index 45bf1dd..0add3ea 100644
--- a/gtkdoc/scangobj.py
+++ b/gtkdoc/scangobj.py
@@ -20,12 +20,11 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 #
 
-#
-# This gets information about object hierarchies and signals
-# by compiling a small C program. CFLAGS and LDFLAGS must be
-# set appropriately before running this script.
-#
-
+"""
+The scangobj tool gets information about object hierarchies and signals by
+compiling and running a small C program. CFLAGS and LDFLAGS must be set
+appropriately before running this script.
+"""
 
 from __future__ import print_function
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]