Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#44 Omit uninformative details

v3.0
closed
5
2007-02-10
2007-01-05
James A. Bednar
No

Hi,

Thanks for releasing this great tool! Would there be any way to provide an option to supress the generation of the entries in the Variables Details section, if those entries would not provide any new information. For instance, all of my files have a variable like __version__ = '$Revision: 1.9 $'. This shows up very reasonably in the Variables section:

Variables
__version__ = '$Revision: 1.9 $'

But the same information is then repeated, in a much longer format, in the Variables Details section:

Variables Details [show private]
__version__
None

Value:

'$Revision: 1.9 $'

Some files or classes have many such variables, which makes the documentation many times longer and more confusing than it would need to be. For a large API such extra info really makes it much harder to read through the documentation than is necessary. It would be great if such redundant information could be suppressed, and the Details included only if there are some variables that do have extra details, and then only list the details for those few variables.

Discussion

    • milestone: --> v3.0
    • assigned_to: edloper --> dvarrazzo
     
  • Logged In: YES
    user_id=1053920
    Originator: NO

    I'm going to drop the uninformative extra blocks before 3.0

     
  • Logged In: YES
    user_id=43908
    Originator: YES

    Great!

    Thanks,

    Jim

     
    • status: open --> closed
     
  • Logged In: YES
    user_id=1053920
    Originator: NO

    Done in r1444