markup doc

tanghaibao · May 11, 2024 · 4d55b17 · 4d55b17
1 parent 9e6368f
commit 4d55b17
Showing 1 changed file with 7 additions and 5 deletions.
diff --git a/jcvi/graphics/base.py b/jcvi/graphics/base.py
@@ -3,10 +3,11 @@
 
 import copy
 import os.path as op
-from os import remove
-
+import re
 import sys
 
+from os import remove
+
 from functools import partial
 from typing import Optional, List, Tuple, Union
 
@@ -408,11 +409,12 @@ def fontprop(ax, name, size=12):
     return prop
 
 
-def markup(s):
+def markup(s: str):
+    """
+    Change the string to latex format, and italicize the text between *.
+    """
     if "$" in s:
         return s
-    import re
-
     s = latex(s)
     s = re.sub(r"\*(.*)\*", r"\\textit{\1}", s)
     return s