From 318d9ad1a4679832b380c77ab1a0a86684f686f2 Mon Sep 17 00:00:00 2001 From: Cody Logan Date: Fri, 1 Dec 2023 15:33:21 -0800 Subject: Switch to Google-style docstrings for readability The previous Sphinx-style docstrings could be hard to read at a glance when formatted with pydoc. --- src/wikiget/logging.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) (limited to 'src/wikiget/logging.py') diff --git a/src/wikiget/logging.py b/src/wikiget/logging.py index e5b955a..7baf4d7 100644 --- a/src/wikiget/logging.py +++ b/src/wikiget/logging.py @@ -35,12 +35,11 @@ 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 + Args: + verbosity (int): integer representation of how verbose the log messages should + be (0 for normal, 1 for verbose, 2 for very verbose) + logfile (str): name of the file to write log messages to, if any + quiet (bool): True if log messages should be suppressed or False otherwise """ loglevel = logging.WARNING # default log level if verbosity >= wikiget.VERY_VERBOSE: -- cgit v1.2.3