Merge pull request #919 from bact/add-desc-tone-detector

Update tone_detector() API description
PyThaiNLP · Jun 23, 2024 · 43f5cc5 · 43f5cc5
2 parents adc6967 + 55d9575
commit 43f5cc5
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/pythainlp/util/syllable.py b/pythainlp/util/syllable.py
@@ -212,8 +212,17 @@ def tone_detector(syllable: str) -> str:
     """
     Thai tone detector for syllables
 
+    Return tone of a syllable.
+
+    - l: low
+    - m: mid
+    - r: rising
+    - f: falling
+    - h: high
+    - empty string: cannot be detected
+
     :param str syllable: Thai syllable
-    :return: syllable's tone (l, m, h, r, f or empty if it cannot be detected)
+    :return: syllable's tone (l, m, h, r, f) or empty if it cannot be detected
     :rtype: str
 
     :Example: