[Checkins] SVN: zope.i18nmessageid/branches/tseaver-no_2to3/docs/ Flesh out docs a bit.
Tres Seaver
cvs-admin at zope.org
Fri Apr 6 22:56:17 UTC 2012
Log message for revision 125053:
Flesh out docs a bit.
Changed:
U zope.i18nmessageid/branches/tseaver-no_2to3/docs/api.rst
U zope.i18nmessageid/branches/tseaver-no_2to3/docs/narr.rst
-=-
Modified: zope.i18nmessageid/branches/tseaver-no_2to3/docs/api.rst
===================================================================
--- zope.i18nmessageid/branches/tseaver-no_2to3/docs/api.rst 2012-04-06 22:49:15 UTC (rev 125052)
+++ zope.i18nmessageid/branches/tseaver-no_2to3/docs/api.rst 2012-04-06 22:56:13 UTC (rev 125053)
@@ -1,5 +1,11 @@
:mod:`zope.i18nmessageid` API Reference
=======================================
+:mod:`zope.i18nmessageid.message`
+---------------------------------
.. automodule:: zope.i18nmessageid.message
+
+ .. autoclass:: Message
+
+ .. autoclass:: MessageFactory
Modified: zope.i18nmessageid/branches/tseaver-no_2to3/docs/narr.rst
===================================================================
--- zope.i18nmessageid/branches/tseaver-no_2to3/docs/narr.rst 2012-04-06 22:49:15 UTC (rev 125052)
+++ zope.i18nmessageid/branches/tseaver-no_2to3/docs/narr.rst 2012-04-06 22:56:13 UTC (rev 125053)
@@ -16,16 +16,17 @@
We can think of a source domain as a collection of messages and
associated translation strings. The domain helps to disambiguate messages
-based on context: for instance, the message whose source string is "draw"
+based on context: for instance, the message whose source string is ``draw``
means one thing in a first-person shooter game, and quite another in a
graphics package: in the first case, the domain for the message might
-be "doom", while in the second it might be "gimp".
+be ``ok_corral``, while in the second it might be ``gimp``.
We often need to create unicode strings that will be displayed by
separate views. The view cannot translate the string without knowing
its source domain. A string or unicode literal carries no domain
-information, therefore we use messages. Messages are unicode strings
-which carry a translation source domain and possibly a default
+information, therefore we use instances of the
+:class:`~zope.i18nmessageid.message.Message` class. Messages are unicode
+strings which carry a translation source domain and possibly a default
translation.
Message Factories
@@ -44,7 +45,7 @@
>>> foo.domain
'myproject'
-The Zope project uses the "zope" domain for its messages. This package
+The Zope project uses the ``zope`` domain for its messages. This package
exports an already-created factory for that domain:
.. doctest::
More information about the checkins
mailing list