make our API docstrings more epydoc friendly

[htsworkflow.git] / htsworkflow / pipelines / run_status.py

diff --git a/htsworkflow/pipelines/run_status.py b/htsworkflow/pipelines/run_status.py
index 2f1a695b333d147455f3a9449684742db1fca2ae..e6a3ed8e6b2f41793f1109dac1334900860e8eaf 100644 (file)
--- a/htsworkflow/pipelines/run_status.py
+++ b/htsworkflow/pipelines/run_status.py
@@ -1,3 +1,5 @@
+__docformat__ = "restructuredtext en"
+
 import glob
 import re
 import os
@@ -397,11 +399,12 @@ def _cmdLineStatusMonitorFunc(conf_info):
   You should probably use startCmdLineStatusMonitor()
   instead of ths function.
 
-  Use with:
-    t = threading.Thread(target=_cmdLineStatusMonitorFunc,
-                         args=[conf_info])
-    t.setDaemon(True)
-    t.start()
+  .. python:
+    def example_launch():
+        t = threading.Thread(target=_cmdLineStatusMonitorFunc,
+                             args=[conf_info])
+        t.setDaemon(True)
+        t.start()
   """
   SLEEP_AMOUNT = 30