[docs] [issue6678] inspect.currentframe documentation omits optional depth parameter

William Mill report at bugs.python.org
Mon Aug 9 05:28:09 CEST 2010

William Mill <bill.mill at gmail.com> added the comment:

Terry: fair enough, I'll add that it's required to be an integer. 

I just meant that the brackets seemed not to be around other keyword arguments, not that it's not optional, sorry for being unclear.

Ben and/or Terry: Would you prefer the inspect.currentframe docs to say something like:

Returns an alias to :func:`sys._getframe` if it exists, otherwise returns a function which always returns ``None``

? I see that as more accurate, but perhaps not as useful to a user of the library who then has to go read the documentation for sys._getframe to find out what the function does.


Python tracker <report at bugs.python.org>

More information about the docs mailing list