Merge pull request #459 from FreifunkBremen/docs-empty-msgstr

Warn of empty msgstr in translations, hint at using comments
2015-08-30 23:53:08 +02:00 · 2015-08-30 23:53:08 +02:00 · 58306fd1c9
parent 15a80aaffd 222fd94ca7
commit 58306fd1c9
1 changed files with 9 additions and 0 deletions
--- a/docs/user/site.rst
+++ b/docs/user/site.rst
@ -284,6 +284,15 @@ for the language files. The command ``msginit -l en -i ../../docs/site-example/i
 can be used from the ``i18n`` directory to create an initial PO file called ``en.po`` if the ``gettext``
 utilities are installed.

+.. note::
+
+   An empty ``msgstr``, as is the default after running ``msginit``, leads to
+   the ``msgid`` being printed as-is. It does *not* hide the whole text, as
+   might be expected.
+
+   Depending on the context, you might be able to use comments like
+   ``<!-- empty -->`` as translations to effectively hide the text.
+
 Examples
 --------