[Epydoc-commits] SF.net SVN: epydoc: [1324] trunk/epydoc/src/epydoc

[<ed...@us...>]

Revision: 1324
Author:   edloper
Date:     2006-08-24 11:56:43 -0700 (Thu, 24 Aug 2006)
ViewCVS:  http://svn.sourceforge.net/epydoc/?rev=1324&view=rev

Log Message:
-----------
- Updated bug reports in code

Modified Paths:
--------------
    trunk/epydoc/src/epydoc/__init__.py
    trunk/epydoc/src/epydoc/docstringparser.py
Modified: trunk/epydoc/src/epydoc/__init__.py
===================================================================
--- trunk/epydoc/src/epydoc/__init__.py	2006-08-24 18:47:28 UTC (rev 1323)
+++ trunk/epydoc/src/epydoc/__init__.py	2006-08-24 18:56:43 UTC (rev 1324)
@@ -183,8 +183,6 @@
        not necessary)
 
 :bug: UserDict.* is interpreted as imported .. why??
-:bug: Nested functions break source colorizer (and *why* is the source
-      colorizer being so slow on the stdlib???)
 
 :license: IBM Open Source License
 :copyright: |copy| 2006 Edward Loper

Modified: trunk/epydoc/src/epydoc/docstringparser.py
===================================================================
--- trunk/epydoc/src/epydoc/docstringparser.py	2006-08-24 18:47:28 UTC (rev 1323)
+++ trunk/epydoc/src/epydoc/docstringparser.py	2006-08-24 18:56:43 UTC (rev 1324)
@@ -375,10 +375,13 @@
     Return a list of user defined fields that can be used for the
     given object.  This list is taken from the given C{api_doc}, and
     any of its containing C{NamepaceDoc}s.
-    
-    @bug: If a child's docstring is parsed before its parents, then
-        its parent won't yet have had its C{extra_docstring_fields}
-        attribute initialized.
+
+    @note: We assume here that a parent's docstring will always be
+        parsed before its childrens'.  This is indeed the case when we
+        are called via L{docbuilder.build_doc_index()}.  If a child's
+        docstring is parsed before its parents, then its parent won't
+        yet have had its C{extra_docstring_fields} attribute
+        initialized.
     """
     docfields = []
     # Get any docfields from `api_doc` itself


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.