[Checkins] SVN: grokui.introspector/trunk/src/grokui/introspector/ Render docstring headings as plaintext to avoid renderer warnings.

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


Log message for revision 90106:
  Render docstring headings as plaintext to avoid renderer warnings.

Changed:
  U   grokui.introspector/trunk/src/grokui/introspector/code.py
  U   grokui.introspector/trunk/src/grokui/introspector/util.py

-=-
Modified: grokui.introspector/trunk/src/grokui/introspector/code.py
===================================================================
--- grokui.introspector/trunk/src/grokui/introspector/code.py	2008-08-21 21:35:26 UTC (rev 90105)
+++ grokui.introspector/trunk/src/grokui/introspector/code.py	2008-08-22 00:35:07 UTC (rev 90106)
@@ -41,6 +41,8 @@
         if item is None:
             item=self.context.context
         docstring = IDocString(item).getDocString(heading_only=heading_only)
+        if heading_only:
+            return render_docstring(docstring, format='zope.source.plaintext')
         return render_docstring(docstring)
 
     def url(self, *args, **kw):

Modified: grokui.introspector/trunk/src/grokui/introspector/util.py
===================================================================
--- grokui.introspector/trunk/src/grokui/introspector/util.py	2008-08-21 21:35:26 UTC (rev 90105)
+++ grokui.introspector/trunk/src/grokui/introspector/util.py	2008-08-22 00:35:07 UTC (rev 90106)
@@ -66,7 +66,7 @@
     renderer = getMultiAdapter((source, TestRequest()))
     return renderer.render()
 
-def render_docstring(docstring, heading_only=False):
+def render_docstring(docstring, heading_only=False, format=None):
     """Get the doc string of the module ReST formatted.
     """
     if docstring is None:
@@ -82,4 +82,4 @@
         lines = headlines
     # Get rid of possible CVS id.
     lines = [line for line in lines if not line.startswith('$Id')]
-    return render_text('\n'.join(lines))
+    return render_text('\n'.join(lines), format=format)



More information about the Checkins mailing list