[Zope3-checkins] CVS: Zope3/src/zope/app/interfaces/content - __init__.py:1.4

Stephan Richter srichter at cosmos.phy.tufts.edu
Fri Feb 20 15:34:08 EST 2004


Update of /cvs-repository/Zope3/src/zope/app/interfaces/content
In directory cvs.zope.org:/tmp/cvs-serv31335/src/zope/app/interfaces/content

Modified Files:
	__init__.py 
Log Message:
Improved doc strings.

Some of the doc strings I encoountered were in horrible shape! Remember,
the API doc tool can only display the info you provide it via the interfaces.
Bad doc strings == bad API documentation!!!


=== Zope3/src/zope/app/interfaces/content/__init__.py 1.3 => 1.4 ===
--- Zope3/src/zope/app/interfaces/content/__init__.py:1.3	Thu Dec 18 11:34:17 2003
+++ Zope3/src/zope/app/interfaces/content/__init__.py	Fri Feb 20 15:33:37 2004
@@ -11,14 +11,18 @@
 # FOR A PARTICULAR PURPOSE.
 #
 ##############################################################################
-"""
+"""Content-related interfaces.
+
 $Id$
 """
-
 from zope.interface.interfaces import IInterface
 
 class IContentType(IInterface):
-    """This interface represents a content type"""
+    """This interface represents a content type.
+
+    If an **interface** implements this interface type, then all object
+    implementing the interface are considered content objects.
+    """
     
 
 




More information about the Zope3-Checkins mailing list