fix wrong docstring

MiczFlor · Dec 26, 2023 · 9176013 · 9176013
1 parent 0c4ad4f
commit 9176013
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 19 deletions.
diff --git a/documentation/developers/docstring/docstring-api.md b/documentation/developers/docstring/docstring-api.md
@@ -626,22 +626,21 @@ def __init__(enable=True, color_levelname=True)
 class PubStream()
 ```
 
-"
-
 Stream handler wrapper around the publisher for logging.StreamHandler
 
 Allows logging to send all log information (based on logging configuration)
 to the Publisher.
 
-ATTENTION: This can lead to recursions!
-
-Recursions come up when
-(a) Publish.send / PublishServer.send also emits logs, which cause a another send, which emits a log,
-    which causes a send, .....
-(b) Publisher initialization emits logs, which need a Publisher instance to send logs
+> [!CAUTION]
+> This can lead to recursions!
+> Recursions come up when
+> * Publish.send / PublishServer.send also emits logs, which cause a another send, which emits a log,
+> which causes a send, .....
+> * Publisher initialization emits logs, which need a Publisher instance to send logs
 
-IMPORTANT: To avoid endless recursions: The creation of a Publisher MUST NOT generate any log messages! Nor any of the
-functions in the send-function stack!
+> [!IMPORTANT]
+> To avoid endless recursions: The creation of a Publisher MUST NOT generate any log messages! Nor any of the
+> functions in the send-function stack!
 
 
 <a id="misc.loggingext.PubStreamHandler"></a>

diff --git a/src/jukebox/misc/loggingext.py b/src/jukebox/misc/loggingext.py
@@ -80,21 +80,22 @@ def filter(self, record):
 
 
 class PubStream:
-    """"
+    """
     Stream handler wrapper around the publisher for logging.StreamHandler
 
     Allows logging to send all log information (based on logging configuration)
     to the Publisher.
 
-    ATTENTION: This can lead to recursions!
-
-    Recursions come up when
-    (a) Publish.send / PublishServer.send also emits logs, which cause a another send, which emits a log,
-        which causes a send, .....
-    (b) Publisher initialization emits logs, which need a Publisher instance to send logs
+    > [!CAUTION]
+    > This can lead to recursions!
+    > Recursions come up when
+    > * Publish.send / PublishServer.send also emits logs, which cause a another send, which emits a log,
+    > which causes a send, .....
+    > * Publisher initialization emits logs, which need a Publisher instance to send logs
 
-    IMPORTANT: To avoid endless recursions: The creation of a Publisher MUST NOT generate any log messages! Nor any of the
-    functions in the send-function stack!
+    > [!IMPORTANT]
+    > To avoid endless recursions: The creation of a Publisher MUST NOT generate any log messages! Nor any of the
+    > functions in the send-function stack!
     """
     def __init__(self):
         self._topic = 'core.logger'