From 96316c8be7bc21617ec5333f87864a0f002ebaa4 Mon Sep 17 00:00:00 2001 From: Cody Logan Date: Wed, 8 Nov 2023 12:53:25 -0800 Subject: Add and refine docstrings in src folder --- src/wikiget/logging.py | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'src/wikiget/logging.py') diff --git a/src/wikiget/logging.py b/src/wikiget/logging.py index a762094..6673877 100644 --- a/src/wikiget/logging.py +++ b/src/wikiget/logging.py @@ -26,6 +26,15 @@ class FileLogAdapter(logging.LoggerAdapter): def configure_logging(verbosity: int, logfile: str, *, quiet: bool) -> None: + """Set the program's log configuration according to the given settings. + + :param verbosity: how verbose the log messages should be + :type verbosity: int + :param logfile: file to write log messages to, if any + :type logfile: str + :param quiet: True if log messages should be suppressed or False otherwise + :type quiet: bool + """ loglevel = logging.WARNING # default log level if verbosity >= wikiget.VERY_VERBOSE: # this includes API and library messages, not just from wikiget -- cgit v1.2.3