update file comments on some Python files so they are recognized by Pylint

Deals with some Pylint missing-module-docstrings.

diff --git a/ci/generate_configuration_table.py b/ci/generate_configuration_table.py
index 3be81d349d52e286c907fade389dff64e1bbec55..f8f78817ae6ecd0e42df8168bdb5b85e45dba853 100755 (executable)
--- a/ci/generate_configuration_table.py
+++ b/ci/generate_configuration_table.py
@@ -1,5 +1,10 @@
 #!/usr/bin/python3
 
+"""
+Generate a table of the Graphviz compile configuration for different platforms
+from files generated by the ./configure command.
+"""
+
 from argparse import ArgumentParser
 import os
 import json

diff --git a/rtest/rtest.py b/rtest/rtest.py
index bb87bbb32c592c664f90955976c9404a5f8f2f6a..2e1859aa19397d1007b4b004194e696f73d323a3 100755 (executable)
--- a/rtest/rtest.py
+++ b/rtest/rtest.py
@@ -1,11 +1,13 @@
 #!/usr/bin/env python3
-#
-# Graphviz regression test driver
-#
-# Also relies on strps.awk.
-#
-# TODO:
-#  Report differences with shared version and with new output.
+
+"""
+Graphviz regression test driver
+
+Also relies on strps.awk.
+
+TODO:
+ Report differences with shared version and with new output.
+"""
 
 import filecmp
 import os

diff --git a/rtest/test_examples.py b/rtest/test_examples.py
index 36ac50296c26ffd25c827632fd4cdf754f921d74..9f98900437dbed8bce2da406948a13d5c3e3ae65 100644 (file)
--- a/rtest/test_examples.py
+++ b/rtest/test_examples.py
@@ -1,4 +1,4 @@
-# tests that examples provided with Graphviz compile correctly
+"""tests that examples provided with Graphviz compile correctly"""
 
 import os
 from pathlib import Path

diff --git a/rtest/test_vmalloc.py b/rtest/test_vmalloc.py
index 347bbf5682377517211c279268446ee7297a3b5a..829166f03d2111edd2f7238f1d120f9d599ee7e0 100644 (file)
--- a/rtest/test_vmalloc.py
+++ b/rtest/test_vmalloc.py
@@ -1,4 +1,4 @@
-# test ../lib/vmalloc
+"""test ../lib/vmalloc"""
 
 import os
 from pathlib import Path

diff --git a/tclpkg/gv/demo/modgraph.py b/tclpkg/gv/demo/modgraph.py
index c23b938bc2d1195717f8e281f3b686e414ce6340..a099156a2bc9ec15145e5fd5719342cee795fce3 100755 (executable)
--- a/tclpkg/gv/demo/modgraph.py
+++ b/tclpkg/gv/demo/modgraph.py
@@ -1,9 +1,11 @@
 #!/usr/bin/env python3
 
-# display the kernel module dependencies
+"""
+display the kernel module dependencies
 
-# author: Michael Hohn <mhhohn@lbl.gov>
-#  based on: modgraph.tcl by John Ellson <ellson@research.att.com>
+author: Michael Hohn <mhhohn@lbl.gov>
+ based on: modgraph.tcl by John Ellson <ellson@research.att.com>
+"""
 
 import gv # pylint: disable=import-error