Skip to content

Commit e48d76a

Browse files
authored
Add additional asciify documentation
This was proposed in #929 but never dealt with, so after going through some confusion around this myself I figured it's about time.
1 parent 7548820 commit e48d76a

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/reference/config.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,10 @@ take place before applying the :ref:`replace` configuration and are roughly
165165
equivalent to wrapping all your path templates in the ``%asciify{}``
166166
:ref:`template function <template-functions>`.
167167

168+
This uses the `unidecode module`_ which is language agnostic, so some
169+
characters may be transliterated from a different language than expected.
170+
For example, Japanese kanji will usually use their Chinese readings.
171+
168172
Default: ``no``.
169173

170174
.. _unidecode module: https://pypi.org/project/Unidecode

0 commit comments

Comments
 (0)