[Checkins] SVN: grokui.introspector/trunk/src/grokui/introspector/util.txt Update tests.

Uli Fouquet uli at gnufix.de
Thu Aug 21 20:35:23 EDT 2008


Log message for revision 90107:
  Update tests.

Changed:
  U   grokui.introspector/trunk/src/grokui/introspector/util.txt

-=-
Modified: grokui.introspector/trunk/src/grokui/introspector/util.txt
===================================================================
--- grokui.introspector/trunk/src/grokui/introspector/util.txt	2008-08-22 00:35:07 UTC (rev 90106)
+++ grokui.introspector/trunk/src/grokui/introspector/util.txt	2008-08-22 00:35:22 UTC (rev 90107)
@@ -62,8 +62,8 @@
   >>> render_text('Hello!\n', module=introspector)
   u'<p>Hello!</p>\n'
 
-render_docstring(docstring, heading_only=False)
-==============================================
+render_docstring(docstring, heading_only=False, format=None)
+============================================================
 
 A function that renders a docstring as restructured text::
 
@@ -102,3 +102,18 @@
   ...
   ... Use it to bazzle bozes.''')
   u'<p>A function to boze bazzles.</p>\n<p>Use it to bazzle bozes.</p>\n'
+
+By default the docstring will be rendered as ReSTructured Text, but we
+can require a different format::
+
+  >>> render_docstring('''
+  ... A line
+  ... Another line''')
+  u'<p>A line\nAnother line</p>\n'
+
+Now the same string rendered as plain text::
+
+  >>> render_docstring('''
+  ... A line
+  ... Another line''', format='zope.source.plaintext')
+  u'A line<br />\nAnother line'



More information about the Checkins mailing list