From 222fd94ca7d05dc76ea9ebed51e03f5e63ec3825 Mon Sep 17 00:00:00 2001
From: Jan-Philipp Litza <janphilipp@litza.de>
Date: Sun, 30 Aug 2015 22:59:36 +0200
Subject: [PATCH] docs: Warn of empty msgstr in translations, hint at using
 comments

---
 docs/user/site.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/docs/user/site.rst b/docs/user/site.rst
index ff67a6a68..055d43baf 100644
--- 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
 --------
 
-- 
GitLab