Re: [Epydoc-devel] Re: epydoc questions

[Robin D. <ro...@al...>]

Robin Dunn wrote:
> Edward Loper wrote:
> 
>> Robin Dunn wrote:
>>
>>>> But I'm sure you don't want *all* imported objects to be listed as 
>>>> if they're defined locally.
>>>
>>>
>>>
>>> Actually, in this case I do want all of them. 
>>
>>
>>
>> For this one module, maybe, but not in general, right?  So maybe what 
>> you want is a module-level way of saying "treat imported objects as 
>> locally defined" instead of an object-level one?
>>
>>> For the docs my preference would be that "core" and "wx.core" does 
>>> not show up anywhere, and that everything that lives in wx.core would 
>>> just be documented as "wx.Whatever".
>>
>>
>>
>> If "core" isn't listed in wx.__all__, then it will be treated as 
>> "private."  Combined with treaing all names in __all__ as locally 
>> defined, this might do what you want.  Alternatively, you might 
>> consider renaming wx.core to wx._core (which will make it very clear 
>> to your users that it's an implementation module, and shouldnt be used 
>> directly).
> 
> 
> 
> Ah, thanks, it makes sense now.  For some reason a couple synapses were 
> not making the connection before.  Now I know how some of my users feel 
> when I point out the obvious to them!  ;-)
> 

In case anybody else is reading this besides Edward and myself, I've 
just attached a patch for implementing this to the RFE:

http://sourceforge.net/tracker/index.php?func=detail&aid=938924&group_id=32455&atid=405621

Works great on wxPython and didn't seem to cause any problems on the 
other tests I threw at it.

-- 
Robin Dunn
Software Craftsman
http://wxPython.org  Java give you jitters?  Relax with wxPython!