Reformat doc strings

Author: dastels

adafruit_logger.py

@@ -42,12 +42,11 @@
 """
 #pylint:disable=redefined-outer-name,consider-using-enumerate,no-self-use
 
-# imports
+import time
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Logger.git"
 
-import time
 
 LEVELS = [(00, 'NOTSET'),
           (10, 'DEBUG'),
@@ -61,7 +60,9 @@
 
 def level_for(value):
     """Convert a numberic level to the most appropriate name.
-    value -- a numeric level
+
+    :param value: a numeric level
+
     """
     for i in range(len(LEVELS)):
         if value < LEVELS[i][0]:
@@ -73,8 +74,10 @@ class LoggingHandler(object):
 
     def format(self, level, msg):
         """Generate a timestamped message.
-        level -- the logging level
-        msg -- the message to log
+
+        :param level: the logging level
+        :param msg: the message to log
+
         """
         now = time.localtime()
         time_vals = (now.tm_year, now.tm_mon, now.tm_mday,
@@ -94,8 +97,10 @@ class PrintHandler(LoggingHandler):
 
     def emit(self, level, msg):
         """Send a message to teh console.
-        level -- the logging level
-        msg -- the message to log
+
+        :param level: the logging level
+        :param msg: the message to log
+
         """
         print(self.format(level, msg))
 
@@ -108,7 +113,9 @@ class Logger(object):
 
     def __init__(self, handler=None):
         """Create an instance.
-        handler -- what to use to output messages. Defaults to a PrintHandler.
+
+        :param handler: what to use to output messages. Defaults to a PrintHandler.
+
         """
         self._level = NOTSET
         if handler is None:
@@ -118,54 +125,65 @@ def __init__(self, handler=None):
 
     @property
     def level(self):
-        """Get the level."""
+        """The level."""
         return self._level
 
     @level.setter
     def level(self, value):
-        """Set the level."""
         self._level = value
 
     def log(self, level, format_string, *args):
         """Log a message.
-        level -- the priority level at which to log
-        format_string -- the core mesage string with embedded formatting directives
-        args -- arguments  format_string.format(), can be empty
+
+        :param level: the priority level at which to log
+        :param format_string: the core message string with embedded formatting directives
+        :param args: arguments to ``format_string.format()``, can be empty
+
         """
         if self._level != NOTSET and level >= self._level:
             self._handler.emit(level, format_string.format(*args))
 
     def debug(self, format_string, *args):
         """Log a debug message.
-        format_string -- the core mesage string with embedded formatting directives
-        args -- arguments  format_string.format(), can be empty
+
+        :param format_string: the core message string with embedded formatting directives
+        :param args: arguments to ``format_string.format()``, can be empty
+
         """
         self.log(DEBUG, format_string, *args)
 
     def info(self, format_string, *args):
         """Log a info message.
-        format_string -- the core mesage string with embedded formatting directives
-        args -- arguments  format_string.format(), can be empty
+
+        :param format_string: the core message string with embedded formatting directives
+        :param args: arguments to ``format_string.format()``, can be empty
+
         """
         self.log(INFO, format_string, *args)
 
     def warning(self, format_string, *args):
         """Log a warning message.
-        format_string -- the core mesage string with embedded formatting directives
-        args -- arguments  format_string.format(), can be empty
+
+        :param format_string: the core message string with embedded formatting directives
+        :param args: arguments to ``format_string.format()``, can be empty
+
         """
         self.log(WARNING, format_string, *args)
 
     def error(self, format_string, *args):
         """Log a error message.
-        format_string -- the core mesage string with embedded formatting directives
-        args -- arguments  format_string.format(), can be empty
+
+        :param format_string: the core message string with embedded formatting directives
+        :param args: arguments to ``format_string.format()``, can be empty
+
         """
         self.log(ERROR, format_string, *args)
 
     def critical(self, format_string, *args):
         """Log a critical message.
-        format_string -- the core mesage string with embedded formatting directives
-        args -- arguments  format_string.format(), can be empty
+
+        :param format_string: the core message string with embedded formatting directives
+        :param args: arguments to ``format_string.format()``, can be empty
+
         """
         self.log(CRITICAL, format_string, *args)