aboutsummaryrefslogtreecommitdiff
path: root/src/wikiget/wikiget.py
diff options
context:
space:
mode:
authorCody Logan <cody@lokken.dev>2023-11-08 12:00:45 -0800
committerCody Logan <cody@lokken.dev>2023-11-08 12:00:45 -0800
commitecaa8a2d019cef5a83a8dc0ed1d4ad5c9fc81a72 (patch)
tree571b803162477b01ff4df5776cfe7972cc216c40 /src/wikiget/wikiget.py
parente8da17d8c6b7fd879e196ae425b8e62c78e579fe (diff)
downloadwikiget-ecaa8a2d019cef5a83a8dc0ed1d4ad5c9fc81a72.tar.gz
wikiget-ecaa8a2d019cef5a83a8dc0ed1d4ad5c9fc81a72.zip
Add and refine docstrings in tests folder.
Diffstat (limited to 'src/wikiget/wikiget.py')
-rw-r--r--src/wikiget/wikiget.py9
1 files changed, 8 insertions, 1 deletions
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)