Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

#97 Some classes are not documented

v3.0
closed
Edward Loper
None
5
2008-02-14
2006-05-15
Pierre Rouleau
No

Under Epydoc 3 Alpha 2 (and Alpha 1), I noticed that
some of my classes sometimes do not get documented.
They arelisted in the class hierarchy but there is no
link to the documentation of the class. The class also
does not get listed inside the list of classes of its
module.

Now, this behaviour seems to be affected by the other
modules: the ones that use that class.

I have a module called 'concrete.py' that declares 2
classes: Representation and Record. Record derives from
Representation.

Then I have another module, h264enc.py, that declares a
class that derives from concrete.Record. If the
h264enc.py module is parsed by epydoc, concrete.Record
is not documented properly. If h264enc.py is not
seen by Epydoc, then concrete.Record is seenand
documented properly. This also occurs with other classes.

I joined images of Epydoc HTML rendering. e1 and e2
show the error. ok1 and ok2 show the correct output
(but without h264enc.py)

Discussion

  • Pierre Rouleau
    Pierre Rouleau
    2006-05-15

    Class hierarchy missing concrete.Record

     
    Attachments
  • Pierre Rouleau
    Pierre Rouleau
    2006-05-15

    concrete.Record missing in Classes list

     
    Attachments
  • Pierre Rouleau
    Pierre Rouleau
    2006-05-15

    concrete.Record is shown if h264enc.py is not processed

     
    Attachments
  • Pierre Rouleau
    Pierre Rouleau
    2006-05-15

    concrete.Record is in class list if h264enc.py is not processed

     
    Attachments
  • Edward Loper
    Edward Loper
    2006-08-22

    Logged In: YES
    user_id=195958

    It's hard to figure out what's going on here without more
    details. My best guess is that for some reason epydoc
    thinks that Record is defined in some other module? Is
    Record actually defined in the concrete module, or
    imported? And are you doing any 'magic' that might affect
    this?

    Does this problem go away if you use --parse-only or --
    introspect-only? If so, that might give me a little more
    information about where the problem is. How hard would it
    be to make a minimal code sample that exhibits this bug?
    I searched for the impath library so I could play with it
    myself, but it looks like it's not publicly available
    anywhere.

    You could also try running with --show-imports; if epydoc
    does think that Record is being defined in some other
    module, then that would let us see which module it is.

     
  • Edward Loper
    Edward Loper
    2006-08-22

    • assigned_to: nobody --> edloper
     
  • Logged In: NO

    I have a similar situation.

    Normally, the class doesn't appear (though other functions
    in that module do) and its own HTML file isn't generated.
    With --parse-only, appears properly.
    With --introspect-only, appears properly.
    (Yes, that's right: only with the default
    parse-and-introspect mode does it not appear, AFAICT.)

    It's in a large proprietary project, and so I can't send
    code, and I don't know if I'll be able to isolate a minimal
    test case for you.

    HTH.

    - K

     
  • Logged In: NO

    Oh, this is with epydoc 3.0alpha3, Python 2.4.2, on win32.

    - K

     
  • Logged In: NO

    This still exists under Alpha 3.

    I've received some code where this happens apparently related to objects inheriting from the 'object' class.

    class WCSbase(object):

    where WCSbase will now be a new-style class.
    http://www.python.org/download/releases/2.2.3/descrintro/

    In this case, the doc page will generate if I remove the (object) in the class declaration.

    William.T.Bridgman.1@gsfc.nasa.gov

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

    Could you please provide a fake version your package, including the modules containing the classes showing the bugs and with a dummy implementation, and the command line/config file used to generate the documentation?

    Thank you very much

     
  • Edward Loper
    Edward Loper
    2007-02-14

    Logged In: YES
    user_id=195958
    Originator: NO

    This might have been fixed by a recent svn checkin -- if you get a chance, please test against svn head and see if the problem is still there.

     
  • Edward Loper
    Edward Loper
    2008-01-31

    Logged In: YES
    user_id=195958
    Originator: NO

    I believed that this was fixed, but can't test that unless either I get access to the package in question (or a mockup-dummy with the same issue), or the original submitter tests it with the current version of epydoc. I'm therefore changing the status of this bug report to 'pending.' If you find that this problem still exists, then please re-open the bug report.

     
  • Edward Loper
    Edward Loper
    2008-01-31

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

    This Tracker item was closed automatically by the system. It was
    previously set to a Pending status, and the original submitter
    did not respond within 14 days (the time period specified by
    the administrator of this Tracker).