Merge pull request cookiecutter#999 from meahow/pep257-log.py

pydocstyle for log.py
zrtalent · Nov 25, 2017 · 092cf2b · 092cf2b
2 parents 58da604 + c7732a9
commit 092cf2b
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/cookiecutter/log.py b/cookiecutter/log.py
@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 
+"""Module for setting up logging."""
+
 import logging
 import sys
 
@@ -18,6 +20,11 @@
 
 
 def configure_logger(stream_level='DEBUG', debug_file=None):
+    """Configure logging for cookiecutter.
+
+    Set up logging to stdout with given level.
+    If debug_file is given set up logging to file with DEBUG level.
+    """
     # Set up 'cookiecutter' logger
     logger = logging.getLogger('cookiecutter')
     logger.setLevel(logging.DEBUG)