diff options
| author | Chris McDonough <chrism@agendaless.com> | 2010-04-19 09:31:49 +0000 |
|---|---|---|
| committer | Chris McDonough <chrism@agendaless.com> | 2010-04-19 09:31:49 +0000 |
| commit | f82fc06112ed9a31a94fe4a7ddfdb1b6f775a8db (patch) | |
| tree | e524bf520aa20de3b85c6ea8c32b9600d28b84f6 /docs/api/i18n.rst | |
| parent | cffb6b8a0141579324565c022de8079c9affe44c (diff) | |
| download | pyramid-f82fc06112ed9a31a94fe4a7ddfdb1b6f775a8db.tar.gz pyramid-f82fc06112ed9a31a94fe4a7ddfdb1b6f775a8db.tar.bz2 pyramid-f82fc06112ed9a31a94fe4a7ddfdb1b6f775a8db.zip | |
Docstrings.
Diffstat (limited to 'docs/api/i18n.rst')
| -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. |