From e48d76a1cd3ff875b7c67e85330f687dae7ed979 Mon Sep 17 00:00:00 2001 From: emiham <65129819+emiham@users.noreply.github.com> Date: Fri, 17 Sep 2021 13:33:31 +0200 Subject: [PATCH] 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. --- docs/reference/config.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/reference/config.rst b/docs/reference/config.rst index f300bd982..0547386a5 100644 --- a/docs/reference/config.rst +++ b/docs/reference/config.rst @@ -165,6 +165,10 @@ take place before applying the :ref:`replace` configuration and are roughly equivalent to wrapping all your path templates in the ``%asciify{}`` :ref:`template function `. +This uses the `unidecode module`_ which is language agnostic, so some +characters may be transliterated from a different language than expected. +For example, Japanese kanji will usually use their Chinese readings. + Default: ``no``. .. _unidecode module: https://pypi.org/project/Unidecode