]> granicus.if.org Git - graphviz/commitdiff
test_shapes.py: address missing docstrings
authorMatthew Fernandez <matthew.fernandez@gmail.com>
Thu, 2 Sep 2021 03:32:52 +0000 (20:32 -0700)
committerMatthew Fernandez <matthew.fernandez@gmail.com>
Sat, 4 Sep 2021 15:21:19 +0000 (08:21 -0700)
tests/regression_tests/shapes/test_shapes.py

index 618472082ac58d78a48033ecbc337bac76f22375..2c10762a78c3c6cb744dbcf9574c3ad0aae8aa08 100644 (file)
@@ -1,3 +1,7 @@
+"""
+Tests that built-in shape types are emitted correctly.
+"""
+
 import os.path
 from pathlib import Path
 from subprocess import Popen, PIPE
@@ -81,6 +85,9 @@ output_types = [
 ]
 
 def generate_shape_graph(shape, output_type):
+  """
+  Produce a graph of the given shape and output format.
+  """
   if not Path("output").exists():
     Path("output").mkdir(parents=True)
 
@@ -114,6 +121,9 @@ def generate_shape_graph(shape, output_type):
                           for output_type in output_types]
 )
 def test_shape(shape, output_type):
+  """
+  Check a shape corresponds to its reference.
+  """
   os.chdir(Path(__file__).resolve().parent)
   generate_shape_graph(shape, output_type)
   assert compare_graphs(shape, output_type)