diff --git a/docs/en_us/developers/source/i18n.rst b/docs/en_us/developers/source/i18n.rst index dfc01aaaf1..892131fd6f 100644 --- a/docs/en_us/developers/source/i18n.rst +++ b/docs/en_us/developers/source/i18n.rst @@ -534,8 +534,9 @@ translation function at runtime to get the localized string. Multiline Strings ================= -Translator notes must directly prepend the string literals to which they refer. +Translator notes must directly precede the string literals to which they refer. For example, the translator note here will not be passed along to translators:: + # Translators: you will not be able to see this note because # I do not directly prepend the line with the translated string literal. # See the line directly below this one does not contain part of the string? @@ -546,6 +547,7 @@ For example, the translator note here will not be passed along to translators:: In such a case, make sure you format your code so that the string begins on a line directly below the translator note:: + # Translators: you will be able to see this note. # See how the line directly below this one contains the start of the string? long_translated_string = _("I am a long string, with many, many words. "