aboutsummaryrefslogtreecommitdiff
path: root/src/wikiget/logging.py
diff options
context:
space:
mode:
authorCody Logan <cody@lokken.dev>2023-12-01 15:33:21 -0800
committerCody Logan <cody@lokken.dev>2023-12-01 15:33:21 -0800
commit318d9ad1a4679832b380c77ab1a0a86684f686f2 (patch)
treeee1bd8ad347c18b3fc44da388360634c3afd231c /src/wikiget/logging.py
parent488e859f8c343b0ef25db379b6339bf82769514b (diff)
downloadwikiget-318d9ad1a4679832b380c77ab1a0a86684f686f2.tar.gz
wikiget-318d9ad1a4679832b380c77ab1a0a86684f686f2.zip
Switch to Google-style docstrings for readability
The previous Sphinx-style docstrings could be hard to read at a glance when formatted with pydoc.
Diffstat (limited to 'src/wikiget/logging.py')
-rw-r--r--src/wikiget/logging.py11
1 files changed, 5 insertions, 6 deletions
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: