From 1916fe0ad51f620cfc5540c8bb5dabf9672e9921 Mon Sep 17 00:00:00 2001 From: Thomas McWork Date: Sun, 31 Mar 2019 13:06:27 +0200 Subject: [PATCH 1/3] Provide an example for the languages list It's hard to impossible to figure out the correct syntax for non python users. --- docs/reference/config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/config.rst b/docs/reference/config.rst index cc5b39c21..87f4165fd 100644 --- a/docs/reference/config.rst +++ b/docs/reference/config.rst @@ -571,7 +571,7 @@ default is ``apply``. languages ~~~~~~~~~ -A list of locale names to search for preferred aliases. For example, setting +A list of locale names to search for preferred aliases (e.g. ``[de,en]``. For example, setting this to "en" uses the transliterated artist name "Pyotr Ilyich Tchaikovsky" instead of the Cyrillic script for the composer's name when tagging from MusicBrainz. Defaults to an empty list, meaning that no language is preferred. From 4cbe116e4258dafdff0da2dbaf38f75df1b7c63b Mon Sep 17 00:00:00 2001 From: Thomas McWork Date: Mon, 1 Apr 2019 09:13:36 +0200 Subject: [PATCH 2/3] use most simple syntax --- docs/reference/config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/config.rst b/docs/reference/config.rst index 87f4165fd..5fcdce3ae 100644 --- a/docs/reference/config.rst +++ b/docs/reference/config.rst @@ -571,7 +571,7 @@ default is ``apply``. languages ~~~~~~~~~ -A list of locale names to search for preferred aliases (e.g. ``[de,en]``. For example, setting +A list of locale names to search for preferred aliases (e.g. ``en jp es``. For example, setting this to "en" uses the transliterated artist name "Pyotr Ilyich Tchaikovsky" instead of the Cyrillic script for the composer's name when tagging from MusicBrainz. Defaults to an empty list, meaning that no language is preferred. From 0e93b0f58dc4db17b65577f87f6a06539f097be3 Mon Sep 17 00:00:00 2001 From: Thomas McWork Date: Sat, 6 Apr 2019 09:29:15 +0200 Subject: [PATCH 3/3] follow comment explanation --- docs/reference/config.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/reference/config.rst b/docs/reference/config.rst index 5fcdce3ae..4d3d6fff1 100644 --- a/docs/reference/config.rst +++ b/docs/reference/config.rst @@ -571,10 +571,12 @@ default is ``apply``. languages ~~~~~~~~~ -A list of locale names to search for preferred aliases (e.g. ``en jp es``. For example, setting -this to "en" uses the transliterated artist name "Pyotr Ilyich Tchaikovsky" +A list of locale names to search for preferred aliases. For example, setting +this to ``en`` uses the transliterated artist name "Pyotr Ilyich Tchaikovsky" instead of the Cyrillic script for the composer's name when tagging from -MusicBrainz. Defaults to an empty list, meaning that no language is preferred. +MusicBrainz. You can use a space-separated list of language abbreviations, like +``en jp es``, to specify a preference order. Defaults to an empty list, meaning +that no language is preferred. .. _detail: