Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect newline added #63

Open
ocervell opened this issue Apr 12, 2024 · 0 comments
Open

Incorrect newline added #63

ocervell opened this issue Apr 12, 2024 · 0 comments

Comments

@ocervell
Copy link

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant