From 149ed2dc3be27e1d336fffddf1bd3cfd6b3ded21 Mon Sep 17 00:00:00 2001
From: Marc Beninca <git@marc.beninca.link>
Date: Tue, 17 Sep 2024 22:22:03 +0200
Subject: [PATCH] doc/log

---
 rwx/log/__init__.py | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/rwx/log/__init__.py b/rwx/log/__init__.py
index 3b245ae..53cfebc 100644
--- a/rwx/log/__init__.py
+++ b/rwx/log/__init__.py
@@ -5,7 +5,12 @@ import sys
 
 
 def get_file_logger(name: str) -> logging.Logger:
-    """Return a file logger."""
+    """Return a file logger.
+
+    :param name: arbitrary name
+    :type name: str
+    :rtype: logging.Logger
+    """
     # formatter
     items = [
         "%(name)s: %(asctime)s",
@@ -27,7 +32,12 @@ def get_file_logger(name: str) -> logging.Logger:
 
 
 def get_stream_logger(level: int) -> logging.Logger:
-    """Return a stream logger."""
+    """Return a stream logger.
+
+    :param level: filtering level
+    :type level: int
+    :rtype: logging.Logger
+    """
     # handler
     out_handler = logging.StreamHandler(stream=sys.stdout)
     out_handler.setLevel(level)