Fixes #20. Add doc note aobut combining diactrical marks.

tsroten · Jun 24, 2023 · d144bbf · d144bbf
1 parent effd5b6
commit d144bbf
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -230,6 +230,11 @@ Additionally, lookahead assertions are used to ensure that hyphens and
 apostrophes are only accepted when they are used correctly. This helps to
 weed out non-Pinyin strings.
 
+.. note::
+    Zhon's pinyin constants do not currently support matching syllables that
+    make use of separate `combining diacritic marks
+    <https://en.wikipedia.org/wiki/Combining_Diacritical_Marks>`_.
+
 .. py:data:: syl
     syllable