Re: [Epydoc-devel] Re: epydoc questions

[Edward L. <ed...@gr...>]

>> This would be hard to do with the current system.  But it should 
>> become easier after I make some of the architectural changes I mentioned.
> 
> Is there anything written about this new architecture that I could 
> review?  

It's pretty preliminary right now.  Once I get a little further along, 
I'll write up a description/explanation, but right now I'm trying to 
figure out exactly how I want it to look.  Some of the motivations 
behind it are...
   - better support for extracting docs via source code parsing
   - plug-in support for extending epydoc (eg there will be a zope
     plug-in that handles zope interfaces, etc.)
   - more consistent & flexible handling of object names.

At some point, I should write up a description & an an explination of 
what's motivating it, but I haven't had a chance yet.  I just checked 
some of my preliminary work in to cvs:

     epydoc/sandbox/epydoc3/epydoc/*

But at this point, it doesn't do much.

> Is there an ETA?  

At least a month, maybe more.  (I don't get as much time to work on 
epydoc as I'd like).

> And if I decide that I am insane enough 
> <wink!> to try and implement the above feature on the current system do 
> you have any suggestions for how to go about doing it?

So basically you want some of the imported objects (eg wx.core.Window) 
to be treated as if they were defined locally.  But I'm sure you don't 
want *all* imported objects to be listed as if they're defined locally.

So epydoc needs some information source to decide which imported objects 
  it should pretend are defined locally.

One option is to use __all__.  In particular, any imported objects 
listed in __all__ will be treated as if they were defined locally.

Another option is to define a new field for the module docstring, that 
declares that an object should be treated as if it was defined locally. 
  Something like "@local: Window", although I'm not crazy about that name.

In either case, you would modify ModuleDoc.__init__ and 
ModuleDoc._find_imported_variables, to treat the desired values as 
non-imported (i.e., add them to self._x instead of self._imported_x).

-Edward