Re: [Pyobjc-dev] Separating functionality into modules

[<bb...@ma...>]

On Sunday, November 17, 2002, at 09:00 AM, Ronald Oussoren wrote:
> I don't think we can do much about what help(Foundation) will show: 
> The pydoc
> module (where help is defined) performs introspection to generate 
> documentation
> for a module. I did notice that help(Foundation) and help(AppKit) use 
> up quite
> a lot of CPU time, but haven't checked if this is caused by 
> inefficiencies in PyObjC or by the sheer size of those modules. If you 
> use 'pydoc -w' on those modules you'll get enormous HTML files.

The documentation generated via introspection should likely be dumped.  
  Actually, it should be moved into a command line tool because it is 
useful, it just isn't what we want the developer to use to figure out 
what methods and classes are available.

Not because of the CPU time consumed, but because of the information 
presented to the developer.  The problem with help(Foundation) and 
help(AppKit) is that they both reveal every nasty little detail about 
Apple's implementation of the Foundation and AppKit.   While this is 
very interesting, it is not the API the developer should be using in 
any but the most extreme of circumstance.

The developer should use the API as advertised by the header files and 
documentation.

b.bum