[Python-bugs-list] [ python-Bugs-471111 ] inspect.getframeinfo() needs docs

[noreply@sourceforge.net]

Bugs item #471111, was opened at 2001-10-14 13:59
You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=471111&group_id=5470

Category: Documentation
Group: Python 2.2
>Status: Closed
>Resolution: Fixed
Priority: 5
Submitted By: Zooko Ozoko (zooko)
Assigned to: Tim Peters (tim_one)
Summary: inspect.getframeinfo() needs docs

Initial Comment:
http://web.lfw.org/python/inspect.html

doesn't include the getmodulename() function and

http://python.sourceforge.net/devel-docs/lib/module-inspect.html

doesn't include the getframeinfo() function,

but:

MAIL imp:~$ python
Python 2.2a4+ (#2, Oct 11 2001, 10:21:08) 
[GCC 2.95.4 20011006 (Debian prerelease)] on linux2
Type "help", "copyright", "credits" or "license" for
more information.
>>> import inspect
>>> dir(inspect)
['BlockFinder', 'CO_NEWLOCALS', 'CO_OPTIMIZED',
'CO_VARARGS', 'CO_VARKEYWORDS', 'EndOfBlock',
'ListReader', '__author__', '__builtins__', '__date__',
'__doc__', '__file__', '__name__', '_searchbases',
'classify_class_attrs', 'currentframe', 'dis',
'findsource', 'formatargspec', 'formatargvalues',
'getabsfile', 'getargs', 'getargspec', 'getargvalues',
'getblock', 'getclasstree', 'getcomments', 'getdoc',
'getfile', 'getframeinfo', 'getinnerframes',
'getlineno', 'getmembers', 'getmodule',
'getmoduleinfo', 'getmodulename', 'getmro',
'getouterframes', 'getsource', 'getsourcefile',
'getsourcelines', 'imp', 'indentsize', 'isbuiltin',
'isclass', 'iscode', 'isframe', 'isfunction',
'ismethod', 'ismethoddescriptor', 'ismodule',
'isroutine', 'istraceback', 'joinseq', 'modulesbyfile',
'os', 're', 'stack', 'string', 'strseq', 'sys',
'tokenize', 'trace', 'types', 'walktree']
>>> 


----------------------------------------------------------------------

>Comment By: Tim Peters (tim_one)
Date: 2001-10-16 16:03

Message:
Logged In: YES 
user_id=31435

Added docs for getframeinfo, in

Doc/lib/libinspect.tex; new revision: 1.6

Closed, as there doesn't appear to be any point to 
reassigning to Ping.

----------------------------------------------------------------------

Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2001-10-15 06:20

Message:
Logged In: YES 
user_id=3066

Assigned to inspect-maintainer-of-the-day for docs.

----------------------------------------------------------------------

Comment By: Martin v. Löwis (loewis)
Date: 2001-10-14 15:04

Message:
Logged In: YES 
user_id=21627

Please note that http://web.lfw.org/python/inspect.html is 
maintained independently, so you should complain to the 
maintainer of this page (Ka-Ping Yee) about 
inconsistencies. The official Python documentation for the 
current release is

http://www.python.org/doc/current/lib/module-inspect.html

and it does mention getmodulename. So it appears that the 
core of your report is that getframeinfo is not documented.

Please understand that two sets of Python documentation 
are maintained: one is the doc strings, which are the 
foundation of Ping's pages (via pydoc). The other is the 
Latex documentation, which is converted automatically into 
the "online" (ie. HTML documentation), where inspect is 
documented in Doc/lib/libinspect.tex.

If you find that the Tex/HTML documentation misses some 
pieces that are worth being mentioned, and if you have 
convenient access to CVS, please also consider providing 
patches for the documentation. In this specific case, it 
might be sufficient to copy the docstring into the tex 
documentation; having such patches available makes it 
easier to integrate them into the documentation.


----------------------------------------------------------------------

You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=471111&group_id=5470