#10 ToDo and Bugs summary pages


It would be great to have epydoc to generate separate
ToDo and Bugs summary pages of all @todo's and @bugs
like JavaDoc does.


  • Edward Loper

    Edward Loper - 2004-03-01

    Logged In: YES

    I like this idea. Any suggestions as to where to put the
    summary pages?

    One option is to add them to the navbar; but that might
    start to look cluttered. Another idea would be to change
    the "Index" page to contain a list of pointers to indices,
    rather than including all the indices directly. (Where the
    indices would be "term index," "identifier index," "to do
    index," and "bug index.") This might also be a good time
    to look at splitting large indices into multiple pages (eg by
    initial letter).

  • Nobody/Anonymous

    Logged In: NO

    As long as the information is easy to retive, that is the
    most importent for me. One suggestion I have is to put it in
    the TOC list.

  • Fred L. Drake, Jr.

    Logged In: YES

    Additional lists that would be nice would be:

    - deprecations

    - version introductions (all features, listed in groups by
    when each was introduced, using the :since: field)

    - feature introductions (all features, listed
    alphabetically, with the version each was introduced in,
    using the :since: field)

    Clearly, deprecations is the most important of these, and
    the later two should only be generated if explicitly enabled
    and :since: fields are actually present. (They aren't
    likely to be useful unless a project is *very* careful about
    :since: annotations.)

  • Edward Loper

    Edward Loper - 2006-08-22

    Logged In: YES

    This has been added as of the most recent subversion
    revision (1291). Currently, indices are generated for
    @bug, @todo, @change, @deprecated, and @since.

  • Edward Loper

    Edward Loper - 2006-08-22
    • status: open --> closed

Log in to post a comment.