From ecaa8a2d019cef5a83a8dc0ed1d4ad5c9fc81a72 Mon Sep 17 00:00:00 2001 From: Cody Logan Date: Wed, 8 Nov 2023 12:00:45 -0800 Subject: Add and refine docstrings in tests folder. --- src/wikiget/wikiget.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'src/wikiget/wikiget.py') diff --git a/src/wikiget/wikiget.py b/src/wikiget/wikiget.py index 06dc458..ca211af 100644 --- a/src/wikiget/wikiget.py +++ b/src/wikiget/wikiget.py @@ -27,6 +27,13 @@ from wikiget.logging import configure_logging def parse_args(argv: list[str]) -> argparse.Namespace: + """Parse the given argument list. + + :param argv: a list of arguments in string form + :type argv: list[str] + :return: a Namespace containing the arguments and their values + :rtype: argparse.Namespace + """ parser = argparse.ArgumentParser( description=""" A tool for downloading files from MediaWiki sites using the file name or @@ -120,7 +127,7 @@ def parse_args(argv: list[str]) -> argparse.Namespace: def cli() -> None: - # setup our environment + """Set up the command-line environment and start the download process.""" args = parse_args(sys.argv[1:]) configure_logging(verbosity=args.verbose, logfile=args.logfile, quiet=args.quiet) -- cgit v1.2.3