From f82fc06112ed9a31a94fe4a7ddfdb1b6f775a8db Mon Sep 17 00:00:00 2001
From: Chris McDonough <chrism@agendaless.com>
Date: Mon, 19 Apr 2010 09:31:49 +0000
Subject: Docstrings.

---
 docs/api/i18n.rst | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'docs/api')

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.
 
 
-- 
cgit v1.2.3