diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/i18n.rst | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/api/i18n.rst b/docs/api/i18n.rst index 48c6d09a4..d76d36383 100644 --- a/docs/api/i18n.rst +++ b/docs/api/i18n.rst @@ -7,7 +7,17 @@ .. autofunction:: get_translator(request) + .. function:: msg(text, domain=None, default=None, mapping=None) + + Create a :class:`repoze.bfg.i18n.TranslationString` instance in + the ``bfg`` domain. If this is a "technical" translation, use a + opaque string for ``text``, and make the ``default`` the format + string. if this is a nontechnical translation, pass only + ``text``. + + .. autoclass:: InterpolationOnlyTranslator + See :ref:`i18n_chapter` for more information about using -:mod:`repoze.bfg` internationalization services in an application. +:mod:`repoze.bfg` internationalization services within an application. |