[Epydoc-commits] SF.net SVN: epydoc: [1524] trunk/epydoc/doc/whatsnew.html
Brought to you by:
edloper
Menu
▾
▴
[Epydoc-commits] SF.net SVN: epydoc: [1524] trunk/epydoc/doc/whatsnew.html
|
From: <dva...@us...> - 2007-02-17 01:25:18
|
Revision: 1524
http://svn.sourceforge.net/epydoc/?rev=1524&view=rev
Author: dvarrazzo
Date: 2007-02-16 17:25:11 -0800 (Fri, 16 Feb 2007)
Log Message:
-----------
- Added new features.
- There's a beta, there's a february...
Modified Paths:
--------------
trunk/epydoc/doc/whatsnew.html
Modified: trunk/epydoc/doc/whatsnew.html
===================================================================
--- trunk/epydoc/doc/whatsnew.html 2007-02-17 01:23:43 UTC (rev 1523)
+++ trunk/epydoc/doc/whatsnew.html 2007-02-17 01:25:11 UTC (rev 1524)
@@ -4,15 +4,14 @@
<link rel="stylesheet" href="epydoc.css" type="text/css"/>
</head>
<!-- $Id: faq.html 602 2003-09-07 23:49:56Z edloper $ -->
-<body>
<body>
<div class="body">
<h1> What's New in Epydoc </h1>
<div class="box">
-<h2 class="box-title">Epydoc 3.0 (alpha)</h2></td>
-<center><i>Alpha 3 released August 24, 2006</i></center>
+<h2 class="box-title">Epydoc 3.0 (beta)</h2>
+<center><i>Beta 1 released February, 2007</i></center>
<h3>Support for Parsing & Introspection</h3>
@@ -21,7 +20,7 @@
contents. Epydoc 3.0 still supports introspection, but is also
capable of extracting information about python modules by parsing
their source code. Furthermore, the new version of epydoc can combine
-these two sources of information (introspection & parsing). This is
+these two sources of information (introspection & parsing). This is
important because each source has its own advantages and disadvantages
with respect to the other. See the <a
href="faq.html#introspect_vs_parse">FAQ</a> for more information about
@@ -49,7 +48,7 @@
<p>Variables may also be documented using <i>comment docstrings</i>.
If a variable assignment is immediately preceeded by a comment whose
-lines begin with the specail marker "<code><b>#:</b></code>", or is
+lines begin with the special marker "<code><b>#:</b></code>", or is
followed on the same line by such a comment, then it is treated as a
docstring for that variable: </p>
@@ -59,7 +58,7 @@
<code class="prompt">>>></code> x = 22 <code class="comment">#: docstring for x</code>
</pre></div>
-<h3> Graphs & Diagrams </h3>
+<h3> Graphs & Diagrams </h3>
<p>Epydoc can automatically generate a variety of graphs, including
class tress, package trees, uml class graphs, and import graphs.
@@ -88,10 +87,15 @@
with epydoc. </a>.</li>
</ul>
+ <p> Epydoc can also generate <i>function call graphs</i>, showing the callers
+ and the callees for each function. To generate call graphs, Epydoc uses
+ data produced by a <a href="http://docs.python.org/lib/profile.html">Python
+ profiler</a> such <code>Profile</code> or <code>hotshot</code>. </p>
+
<p> For some examples of automatically generated graphs, see the <a
href="api/">API Documentation</a> for epydoc (including the page
for the <a href="api/epydoc.docwriter.dotgraph-module.html"
- ><code>epydoc.docwriter.dotgraph</code> module</a>. </p>
+ ><code>epydoc.docwriter.dotgraph</code> module</a>). </p>
<p> Graph generation requires the <a
href="http://www.graphviz.org/">Graphviz package</a>
@@ -113,7 +117,9 @@
listed, but no longer described in detail. E.g., if "object" is
used as a base class, then the methods inherited from "object" will
be listed at the bottom of the method summary table, but not
- described in detail.</li>
+ described in detail. Furthermore methods and variables not very detailed
+ (with at most a short docstring) are only shown in the summary, while
+ most detailed items also appear in a full detailed box. </li>
<li> The HTML output no longer contains separate pages for including
and excluding private variables. Instead, it uses CSS to
@@ -121,6 +127,15 @@
record the user's preference. (By default, private variables are
hidden.) </li>
+ <li> Additional pages are created, listing identifiers, documented
+ definitions, bugs and to-do items. An optional log page can also be
+ generated, reporting all the errors and warning raised during documentation
+ generation. </li>
+
+ <li> Improved variable values representation, using the parsed values if
+ the standard representation is not informative (such as <code><Foo
+ instance at ...></code>). Syntax highlight is used for values too,
+ including colorization for regular expressions. </li>
</ul>
<h3>Improved Documentation Extraction</h3>
@@ -128,8 +143,15 @@
<ul>
<li> Proper support for nested classes.</li>
<li> Full unicode support, including support for the <a href="http://www.python.org/peps/pep-0263.html">encoding directive</a>.</li>
+ <li> Variables conventionally used for modules metadata such as
+ <code>__version__</code> are recognized as modules fields.</li>
+ <li>The <code>__all__</code> attribute is used to decide whether objects
+ are public or private. If an object is listed in an <code>__all__</code>
+ list, it will appear defined in that module even if imported from elsewhere,
+ keeping the API safe from implementation changes.</li>
<li> Increased robustness in the face of a variety of "magic"
manipulations of namespaces.</li>
+ <li>Parsing or introspection can be prevented for problematic modules.</li>
</ul>
</div>
@@ -204,24 +226,25 @@
<li> Added --ignore-param-mismatch option, which supresses warnings about parameter mismatches </li>
<li> Fixed bug in path magic for epydoc.py and epydoc.pyw scripts </li>
<li> Replaced __epydoc_sort__ with @sort </li>
- <li> Changes to epytext:</li>
+ <li> Changes to epytext:
<ul>
<li> Epytext now supports symbols (S{...}) </li>
<li> Epydoc allows multi-word values for field arguments (eg for group names) </li>
<li> Fixeded several minor bugs</li>
- </ul>
- <li> --show-imports now lists imported vars & modules </li>
+ </ul>
+ </li>
+ <li> --show-imports now lists imported vars & modules </li>
<li> Improvements to error reporting </li>
<li> Improved sorting </li>
<li> Many bug fixes </li>
<li> General code clean-up </li>
<li> Added preliminary and partial implementation for man-style output (like pydoc) </li>
<li> Changed the definition of the --navlink parameter, to allow for more flexible encoding of the homepage link. </li>
- <li> Improvements to HTML output. </li>
+ <li> Improvements to HTML output.
<ul>
<li> Display variable values in variable summary table </li>
<li> Added tooltips for variable values, that show a more complete value (up to 600 characters) </li>
- <li> Minor tweaks & improvements </li>
+ <li> Minor tweaks & improvements </li>
<li> In the table of contents, only list objects from modules that were explicitly documented (don't list base classes from imported modules, etc)</li>
</ul>
</li>
@@ -230,7 +253,7 @@
<div class="box"><h2 class="box-title">Older Releases</h2>
<p>See the <a
-href="http://sourceforge.net/project/showfiles.php?group_id=32455&package_id=24617">Release
+href="http://sourceforge.net/project/showfiles.php?group_id=32455&package_id=24617">Release
Notes</a> on SourceForge.</p>
</div>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|