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

[Fred L. Drake, Jr.]

Log message for revision 28548:
  document the `length` argument to ILocaleDates.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 18:57:19 UTC (rev 28547)
+++ Zope3/trunk/src/zope/i18n/interfaces/locales.py	2004-12-01 19:09:28 UTC (rev 28548)
@@ -394,6 +394,10 @@
         """Get a date/time formatter.
 
         `category` must be one of 'date', 'dateTime', 'time'.
+
+        The 'length' specifies the output length of the value. The allowed
+        values are: 'short', 'medium', 'long' and 'full'. If no length was
+        specified, the default length is chosen.
         """