[Checkins] SVN: zope.introspector/trunk/src/zope/introspector/interfaces.py Add interface for docstring finder.

[Uli Fouquet]

Log message for revision 89791:
  Add interface for docstring finder.

Changed:
  U   zope.introspector/trunk/src/zope/introspector/interfaces.py

-=-
Modified: zope.introspector/trunk/src/zope/introspector/interfaces.py
===================================================================
--- zope.introspector/trunk/src/zope/introspector/interfaces.py	2008-08-13 11:21:17 UTC (rev 89790)
+++ zope.introspector/trunk/src/zope/introspector/interfaces.py	2008-08-13 12:06:06 UTC (rev 89791)
@@ -172,3 +172,12 @@
         The default layer will be returned with u'' as the skin name.
         """
 
+class IDocString(interface.Interface):
+    """Objects that have a docstring.
+    """
+    def getDocString(header_only=True):
+        """Get the docstring.
+
+        If header_only is `True`, return the whole
+        docstring. Otherwise only the part up to the first blank line.
+        """