testbeds, prototypes, model: Add docstrings

This adds docstrings for methods of in the testbeds, prototypes and
certain things in the model.

1 files changed, 9 insertions, 4 deletions

diff --git a/rumba/log.py b/rumba/log.py
index 3a21ee1..67070a6 100644
--- a/rumba/log.py
+++ b/rumba/log.py
@@ -169,7 +169,9 @@ except ImportError:
 
 
 class RumbaFormatter(logging.Formatter):
-    """The logging.Formatter subclass used by Rumba"""
+    """
+    The logging.Formatter subclass used by Rumba
+    """
 
     level_name_table = {
         'CRITICAL': 'CRT',
@@ -232,6 +234,7 @@ def get_logger(name):
     Returns the logger named <name>.
     <name> should be the module name, for consistency. If setup has not been
     called yet, it will call it first.
+
     :param name: the name of the desired logger
     :return: The logger
     """
@@ -271,9 +274,8 @@ def set_logging_level(level, name=None):
 
 def reset_logging_level():
     """
-    Resets the current logging levels to the defaults.
-    Defaults are: rumba           -> INFO,
-                  everything else -> ERROR
+    Resets the current logging levels to the defaults. For Rumba the
+    default is INFO.
     """
     # Un-sets every logger previously set
     for logger in loggers_set:
@@ -283,6 +285,9 @@ def reset_logging_level():
 
 
 def flush_log():
+    """
+    Flush the log.
+    """
     time.sleep(0.1)