classification
Title: inspect.currentframe documentation omits optional depth parameter
Type: feature request Stage:
Components: Documentation Versions: Python 3.2, Python 3.1, Python 3.0, Python 2.7, Python 2.6, Python 2.5, Python 2.4
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: georg.brandl, llimllib (2)
Priority: Keywords

Created on 2009-08-10 18:25 by llimllib, last changed 2009-08-10 18:25 by llimllib.

Messages (1)
msg91459 - (view) Author: William Mill (llimllib) Date: 2009-08-10 18:24 
help(inspect.currentframe) reads:

---------------------------------
_getframe(...)
    _getframe([depth]) -> frameobject

Return a frame object from the call stack.  If optional integer depth is
given, return the frame object that many calls below the top of the
stack. If that is deeper than the call stack, ValueError is raised.  The
default for depth is zero, returning the frame at the top of the call stack.
        
This function should be used for internal and specialized
purposes only.
-------------------------------

The python library documentation, however, doesn't mention the optional
depth parameter:

-------------------------------
inspect.currentframe()
    Return the frame object for the caller’s stack frame.
-------------------------------

I think substituting the help() text for the library documentation's
text would be an improvement.
History
Date User Action Args
2009-08-10 18:25:00llimllibcreate