From ae92ef4425795f75bb0512353faf437a1da4cbc6 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Thu, 15 Sep 2022 11:23:00 -0400 Subject: [PATCH] bin/djbdns-logparse.py: add a docstring for main(). --- bin/djbdns-logparse.py | 6 ++++++ 1 file changed, 6 insertions(+) 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 -- 2.43.2