gpt4docstrings icon indicating copy to clipboard operation
gpt4docstrings copied to clipboard

Incorrect newline added

Open ocervell opened this issue 4 months ago • 0 comments

def setup_logging(level):
	"""
    Setup logging.

    Args:
        level (int): logging level.

    Returns:
        logging.Logger: logger.
    """
	logger = logging.getLogger('secator')
	logger.setLevel(level)
	ch = logging.StreamHandler()
	ch.setLevel(level)
	formatter = logging.Formatter('%(message)s')
	ch.setFormatter(formatter)
	logger.addHandler(ch)
	return logger

The first line of the docstring should be: """Setup logging."""

to comply with google pep style for docstrings (https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).

ocervell avatar Apr 12 '24 13:04 ocervell