[py-svn] r35032 - py/dist/py/documentation

[mwh at codespeak.net]

Author: mwh
Date: Mon Nov 27 14:29:18 2006
New Revision: 35032

Modified:
   py/dist/py/documentation/apigen.txt
Log:
clarify pydoctor's intent.
also, it works on the py lib now.


Modified: py/dist/py/documentation/apigen.txt
==============================================================================
--- py/dist/py/documentation/apigen.txt	(original)
+++ py/dist/py/documentation/apigen.txt	Mon Nov 27 14:29:18 2006
@@ -154,13 +154,14 @@
 
 This tool is written by Michael Hudson for the Twisted project. The major
 difference between this and Epydoc is that it browses the AST (Abstract Syntax
-Tree) instead of using 'live' objects, which makes that code that uses special
-import mechanisms, or depends on other code that is not available, can still
-be inspected.
+Tree) instead of using 'live' objects, which means that code that uses special
+import mechanisms, or depends on other code that is not available can still be
+inspected. On the other hand, code that, for example, puts bound methods into a
+module namespace is not documented.
 
 The tool is relatively simple and doesn't support the more advanced features
-that Epydoc offers, and since it's written basically only for Twisted, I don't
-think it will see a lot of development in the future.
+that Epydoc offers. It was written for Twisted and there are no current plans to
+promote its use for unrelated projects.
 
 Quick overview:
 
@@ -168,9 +169,7 @@
   * again not a lot of information, the usual API docstrings, class inheritance
     and module structure, but that's it
   * rather heavy dependencies (depends on Twisted/Nevow (trunk version))
-  * written for Twisted, but quite nice output with other applications (except
-    that generating docs of the 'py lib' resulted in a max recursion depth
-    error)
+  * written for Twisted, but quite nice output with other applications
 
 Quick overview lists of the other tools
 +++++++++++++++++++++++++++++++++++++++