From: Michael Orlitzky <michael@orlitzky.com>
Date: Thu, 22 Sep 2022 11:57:55 +0000 (-0400)
Subject: djbdns/*.py: add module docstrings.
X-Git-Tag: 0.0.1~4
X-Git-Url: http://gitweb.michael.orlitzky.com/?p=djbdns-logparse.git;a=commitdiff_plain;h=10dae9a1381fae23e83040adff92ecbb00693db2

djbdns/*.py: add module docstrings.
---

diff --git a/djbdns/common.py b/djbdns/common.py
index ea5dd31..5ab9b5f 100644
--- 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 ac8b41c..fcd0a0d 100644
--- 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 1e41470..7af36a0 100644
--- 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 2d9741e..0b60a51 100644
--- 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