From: Michael Orlitzky <michael@orlitzky.com>
Date: Thu, 15 Sep 2022 15:23:00 +0000 (-0400)
Subject: bin/djbdns-logparse.py: add a docstring for main().
X-Git-Tag: 0.0.1~44
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=ae92ef4425795f75bb0512353faf437a1da4cbc6;p=djbdns-logparse.git

bin/djbdns-logparse.py: add a docstring for main().
---

diff --git a/bin/djbdns-logparse.py b/bin/djbdns-logparse.py
index b407411..689e33b 100755
--- a/bin/djbdns-logparse.py
+++ b/bin/djbdns-logparse.py
@@ -301,6 +301,12 @@ def parse_logfile(file : typing.TextIO):
         print(line)
 
 def main():
+    r"""
+    The entry point to the program.
+
+    This function is responsible only for parsing any command-line
+    arguments, and then calling :func`parse_logfile` on them.
+    """
     # Create an argument parser using the file's docsctring as its
     # description.
     from argparse import ArgumentParser, FileType