style: refactor docstrings for log.py and views.py

ReadAlongs · Feb 4, 2022 · c369d17 · c369d17
1 parent c36ffa3
commit c369d17
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 23 deletions.
diff --git a/readalongs/log.py b/readalongs/log.py
@@ -1,13 +1,6 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-#######################################################################
-#
-# log.py
-#
-#   Setup a logger that has colours!
-#
-#######################################################################
+"""
+log.py: Setup a logger that has colours!
+"""
 
 import logging
 
@@ -17,7 +10,7 @@
 
 
 def setup_logger(name):
-    """ Create logger and configure with cool colors!
+    """Create logger and configure with cool colors!
     """
     logging.basicConfig(level=logging.INFO)
     logger = logging.getLogger(name)

diff --git a/readalongs/views.py b/readalongs/views.py
@@ -1,15 +1,9 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-#######################################################################
-#
-# views.py
-#
-#   Views for ReadAlong Studio web application
-#   Interactions are described as websocket events and responses
-#   Corresponding JavaScript is found in readalongs/static/js/main.js
-#
-#######################################################################
+"""
+views.py: Views for ReadAlong Studio web application
+
+Interactions are described as websocket events and responses
+Corresponding JavaScript is found in readalongs/static/js/main.js
+"""
 
 import io
 import os