Skip to content

Commit

Permalink
docs: Update docstring for configure_logging
Browse files Browse the repository at this point in the history
  • Loading branch information
ronaldmaj committed Aug 16, 2024
1 parent 0d30aa1 commit 28132d0
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions gnssanalysis/gn_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

import click as _click

from typing import List as _List
from typing import List as _List, Union as _Union


def diffutil_verify_input(input):
Expand Down Expand Up @@ -52,7 +52,13 @@ def get_filetype(path):
return suffix


def configure_logging(verbose: bool, output_logger: bool = False) -> None:
def configure_logging(verbose: bool, output_logger: bool = False) -> _Union[_logging.Logger, None]:
"""_summary_
:param bool verbose: Set up the logger object to use for encoding logging strings
:param bool output_logger: Flag to indicate whether to output the Logger object, defaults to False
:return _Union[_logging.Logger, None]: Return the logger object or None (based on output_logger)
"""
if verbose:
logging_level = _logging.DEBUG
else:
Expand Down

0 comments on commit 28132d0

Please sign in to comment.