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

Close

#16 Ability to hide implementation details

open
Edward Loper
Other (25)
5
2004-04-20
2004-04-20
Robin Dunn
No

Using the new wx package several of the core submodules
are imported into the package namespace so the
programmer doesn't have to worry about explicitly
importing those submodules. For example, instead of
using wx.core.Window the programmer will just use
wx.Window. It would be nice to be able to cause epydoc
to document the objects in those submodules as if they
were actually in wx itself? That way the reader of the
docs still won't have to know anything about the
implementation details and the docs will accurately
reflect how it is supposed to be used.

Discussion

  • Robin Dunn
    Robin Dunn
    2004-04-26

    Logged In: YES
    user_id=53955

    Attached is a patch that implements this (along with a
    cumulation of my other patches that havn't been checked in yet.)

    I also noticed that sometimes a duplicate ObjectUID could be
    created for modules and classes due to the use of
    ObjectUID() instead of make_uid in the parent(),
    _findname(), etc. methods so I changed all of them to
    make_uid.

     
  • Robin Dunn
    Robin Dunn
    2004-04-26

     
    Attachments
  • Robin Dunn
    Robin Dunn
    2004-04-27

    Logged In: YES
    user_id=53955

    BTW, while googling around about this I noticed some
    comments from Python folks that maybe __all__ shouldn't be
    overloaded like this (public vs. private) for doc tools.
    Was that resolved? Or should epydoc be changed to use a
    __doclocal__ list?