[Zope3-checkins] SVN: Zope3/trunk/src/zope/i18n/interfaces/locales.py document the `category` argument to getFormatter()

[Fred L. Drake, Jr.]

Log message for revision 28547:
  document the `category` argument to getFormatter()

Changed:
  U   Zope3/trunk/src/zope/i18n/interfaces/locales.py

-=-
Modified: Zope3/trunk/src/zope/i18n/interfaces/locales.py
===================================================================
--- Zope3/trunk/src/zope/i18n/interfaces/locales.py	2004-12-01 17:41:11 UTC (rev 28546)
+++ Zope3/trunk/src/zope/i18n/interfaces/locales.py	2004-12-01 18:57:19 UTC (rev 28547)
@@ -391,9 +391,12 @@
                          description=u"This is a ILocaleTimeZone object."))
 
     def getFormatter(category, length=None, name=None, calendar=u'gregorian'):
-        """Get a date/time formatter."""
+        """Get a date/time formatter.
 
+        `category` must be one of 'date', 'dateTime', 'time'.
+        """
 
+
 class ILocaleCurrency(Interface):
     """Defines a particular currency."""