MichaelisTrofficus / gpt4docstrings

Generating Python docstrings with OpenAI ChatGPT!!
https://gpt4docstrings.readthedocs.io
MIT License
120 stars 12 forks source link

Incorrect newline added #63

Open ocervell opened 7 months ago

ocervell commented 7 months ago
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).