djbdns/*.py: add module docstrings.

diff --git a/djbdns/common.py b/djbdns/common.py
index ea5dd310a79f98486a663caaf2b53fe40b15fede..5ab9b5f166f14f986be91b020db2382a791edfda 100644 (file)
--- a/djbdns/common.py
+++ b/djbdns/common.py
@@ -1,3 +1,6 @@
+r"""
+Information needed to parse *both* tinydns and dnscache logs.
+"""
 from struct import pack
 
 # A pattern to match the timestamp format that the tai64nlocal program

diff --git a/djbdns/dnscache.py b/djbdns/dnscache.py
index ac8b41c5656ba747b458832f069123c6f028e06b..fcd0a0d050c5f8fb8d04ca85d83a12a7324cb650 100644 (file)
--- a/djbdns/dnscache.py
+++ b/djbdns/dnscache.py
@@ -1,3 +1,6 @@
+r"""
+Functions and data specific to dnscache logs.
+"""
 # Don't clobber the global compile() with a named import.
 import re
 

diff --git a/djbdns/io.py b/djbdns/io.py
index 1e41470452a30e4c56438ff2ab1ea84a210b0566..7af36a0233949b70039a1e76f1f7042607d66d46 100644 (file)
--- a/djbdns/io.py
+++ b/djbdns/io.py
@@ -1,3 +1,7 @@
+r"""
+Functions that perform input/output. This forms a layer between the
+executable itself and the more libraryish modules.
+"""
 from subprocess import Popen, PIPE
 from typing import TextIO
 from djbdns.dnscache import handle_dnscache_log

diff --git a/djbdns/tinydns.py b/djbdns/tinydns.py
index 2d9741ed8cf92765afbb9d602fc837de6b1a69e5..0b60a512983e29992482aa45bb9d577a5a772589 100644 (file)
--- a/djbdns/tinydns.py
+++ b/djbdns/tinydns.py
@@ -1,3 +1,6 @@
+r"""
+Functions and data specific to tinydns logs.
+"""
 # Don't clobber the global compile() with a named import.
 import re