Fix style issues with doctest tests.

glotzerlab · Jun 18, 2020 · 7b60a3b · 7b60a3b
1 parent e0ae69d
commit 7b60a3b
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/tests/test_docstrings.py b/tests/test_docstrings.py
@@ -1,3 +1,4 @@
+"""Test examples in code docstrings using doctest."""
 import doctest
 import pkgutil
 import unittest
@@ -6,11 +7,12 @@
 
 
 def load_tests(loader, tests, ignore):
-    modules = pkgutil.walk_packages(rowan.__path__, rowan.__name__ + '.')
+    """Create tests from all docstrings by walking the package hierarchy."""
+    modules = pkgutil.walk_packages(rowan.__path__, rowan.__name__ + ".")
     for _, module_name, _ in modules:
-        tests.addTests(doctest.DocTestSuite(module_name, globs={'rowan': rowan}))
+        tests.addTests(doctest.DocTestSuite(module_name, globs={"rowan": rowan}))
     return tests
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     unittest.main()