From: Matthew Fernandez <matthew.fernandez@gmail.com>
Date: Sat, 3 Jul 2021 02:37:59 +0000 (-0700)
Subject: update file comments on some Python files so they are recognized by Pylint
X-Git-Tag: 2.48.0~9^2~8
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=9ae566056e01928d6e3c6fabf1e9bef589ee7756;p=graphviz

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 3be81d349..f8f78817a 100755
--- 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 bb87bbb32..2e1859aa1 100755
--- 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 36ac50296..9f9890043 100644
--- 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 347bbf568..829166f03 100644
--- 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 c23b938bc..a099156a2 100755
--- 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