From 10dae9a1381fae23e83040adff92ecbb00693db2 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Thu, 22 Sep 2022 07:57:55 -0400 Subject: [PATCH] djbdns/*.py: add module docstrings. --- djbdns/common.py | 3 +++ djbdns/dnscache.py | 3 +++ djbdns/io.py | 4 ++++ djbdns/tinydns.py | 3 +++ 4 files changed, 13 insertions(+) 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 -- 2.43.2