[Checkins] SVN: zope.introspectorui/trunk/src/zope/introspectorui/util.txt Update tests.

[Uli Fouquet]

Log message for revision 89649:
  Update tests.

Changed:
  U   zope.introspectorui/trunk/src/zope/introspectorui/util.txt

-=-
Modified: zope.introspectorui/trunk/src/zope/introspectorui/util.txt
===================================================================
--- zope.introspectorui/trunk/src/zope/introspectorui/util.txt	2008-08-11 13:54:03 UTC (rev 89648)
+++ zope.introspectorui/trunk/src/zope/introspectorui/util.txt	2008-08-11 13:54:35 UTC (rev 89649)
@@ -59,3 +59,41 @@
 
   >>> provider.getBreadcrumbs()
   '<a href="http://.../zope">zope</a>.<a href="http://.../zope/introspector">introspector</a>'
+
+
+`get_doc_format(module)`
+------------------------
+
+This function was taken from ``zope.app.apidoc``. It inspects a module
+to determine the supported documentation format. The function returns
+a valid renderer source factory id.
+
+If the `__docformat__` module attribute is specified, its value will
+be used to look up the factory id:
+
+  >>> from zope.introspectorui.util import get_doc_format
+  >>> from zope import introspector
+  >>> get_doc_format(introspector)
+  'zope.source.plaintext'
+
+By default and different to ``zope.app.apidoc``, plain text is returned:
+
+  >>> from zope.introspectorui import tests
+  >>> get_doc_format(tests)
+  'zope.source.plaintext'
+
+The `__docformat__` attribute can also optionally specify a language field. We
+simply ignore it:
+
+  >>> class Module(object):
+  ...     pass
+  >>> module = Module()
+  >>> module.__docformat__ = 'structuredtext en'
+  >>> get_doc_format(module)
+  'zope.source.stx'
+
+The third supported source factory id is 'restructuredtext'::
+
+  >>> module.__docformat__ = 'restructuredtext'
+  >>> get_doc_format(module)
+  'zope.source.rest'