summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2010-04-19 15:04:17 +0000
committerChris McDonough <chrism@agendaless.com>2010-04-19 15:04:17 +0000
commit1c7039e337401ceb7eb16040234dcf9da8335f55 (patch)
tree12796eb5438845c1c2f747443aaab9b80a283d50
parent3f8195a1b05dbc0a6ed039ea645d95359a7f87c8 (diff)
downloadpyramid-1c7039e337401ceb7eb16040234dcf9da8335f55.tar.gz
pyramid-1c7039e337401ceb7eb16040234dcf9da8335f55.tar.bz2
pyramid-1c7039e337401ceb7eb16040234dcf9da8335f55.zip
Docstring tweak.
-rw-r--r--repoze/bfg/i18n.py9
1 files changed, 7 insertions, 2 deletions
diff --git a/repoze/bfg/i18n.py b/repoze/bfg/i18n.py
index 433dfed5a..adbdb1db6 100644
--- a/repoze/bfg/i18n.py
+++ b/repoze/bfg/i18n.py
@@ -126,17 +126,22 @@ def get_translator(request, translator_factory=None):
return translator
class InterpolationOnlyTranslator(object):
+
""" A class implementing the :term:`translator factory` interface
as its constructor and the :term:`translator` interface as its
``__call__`` method. Useful as a minimal translator factory, this
class only does basic interpolation of mapping values; it does not
- actually do any language translations. Use::
+ actually do any language translations and ignores all
+ :term:`translation domain` information. To use it explicitly::
from repoze.bfg.configuration import Configurator
from repoze.bfg.i18n import InterpolationOnlyTranslator
config = Configurator(translator_factory=InterpolationOnlyTranslator)
- """
+ An instance of this class is returned by
+ :func:`repoze.bfg.i18n.get_translator` if no explicit translator
+ factory is registered.
+ """
classProvides(ITranslatorFactory)
implements(ITranslator)
def __init__(self, request):