[Doc-SIG] htmldoc.py and inspect.py

Ka-Ping Yee ping@lfw.org
Tue, 30 May 2000 10:13:40 -0700 (PDT)

On Tue, 30 May 2000, Ka-Ping Yee wrote:
> To do:
>     - no directory/package indexing yet
>     - simple HTTP server (so you can get fresh docs on your own modules)

Two more items:
    - command-line program ("pydoc"?) for showing a plain-text
      "man"-style page for a module
    - better rule for deciding when a function belongs to a module

Current rule is:
    - if function is built-in, always include it
    - if function's func_code.co_filename matches module, include it

Proposed new rule:
    - if function is built-in, include it only if module does not
      come from a .py or .pyc
    - if function's func_code.co_filename matches module, include it

(see http://www.lfw.org/python/htmldoc/calendar.html for goof:
all the time.*() functions are visible)

It would probably be nice to show a list of the functions and
classes that have been imported from other modules, but not
generate redundant documentation for them.  Sound right?

-- ?!ng

"To be human is to continually change.  Your desire to remain as you are
is what ultimately limits you."
    -- The Puppet Master, Ghost in the Shell