More WIP

src/shelllogger/ShellLogger.py

@@ -393,22 +393,22 @@ def add_child(self, child_name: str) -> ShellLogger:
         return child
 
     @staticmethod
-    def strfdelta(tdelta: timedelta, fmt: str) -> str:
+    def strfdelta(delta: timedelta, fmt: str) -> str:
         """
         Format a time delta object.  Use this like you would
         :func:`datetime.strftime`.
 
         Parameters:
-            tdelta:  The time delta object.
+            delta:  The time delta object.
             fmt:  The delta format string.
 
         Returns:
             A string representation of the time delta.
         """
 
         # Dictionary to hold time delta info.
-        d = {'days': tdelta.days}
-        total_ms = tdelta.microseconds + (tdelta.seconds * 1000000)
+        d = {'days': delta.days}
+        total_ms = delta.microseconds + (delta.seconds * 1000000)
         d['hrs'], rem = divmod(total_ms, 3600000000)
         d['min'], rem = divmod(rem, 60000000)
         d['sec'] = rem / 1000000
@@ -573,7 +573,7 @@ def log(
 
         Note:
             To conserve memory, ``stdout`` and ``stderr`` will be
-            written to the files as they are being generated.
+            written to files as they are being generated.
         """
         start_time = datetime.now()
 

src/shelllogger/util.py

@@ -121,7 +121,7 @@ def flatten(element: object) -> object:
     Takes a tree of lists and turns it into a flat iterables.  Ish.
 
     Parameters:
-        element:
+        element:  Todo:  Figure this out.
     """
     if isinstance(element, str):
         yield element
@@ -719,6 +719,8 @@ def embed_style(resource: str) -> str:
 
     Returns:
         A string containing the ``<style>...</style>`` block.
+
+    Todo:  Combine this with the two below?
     """
     return ("<style>\n"
             + pkgutil.get_data(__name__, f"resources/{resource}").decode()
@@ -767,6 +769,8 @@ def load_template(template: str) -> str:
 
     Returns:
         A string containing the contents of the file.
+
+    Todo:  Combine with the one above?
     """
     template_file = f"resources/templates/{template}"
     return pkgutil.get_data(__name__, template_file).decode()