[Python-checkins] r74781 - in python/trunk/Doc/library: inspect.rst sys.rst

[michael.foord]

Author: michael.foord
Date: Sun Sep 13 18:46:19 2009
New Revision: 74781

Log:
Note that sys._getframe is not guaranteed to exist in all implementations of Python, and a corresponding note in inspect.currentframe. Issue 6712.

Modified:
   python/trunk/Doc/library/inspect.rst
   python/trunk/Doc/library/sys.rst

Modified: python/trunk/Doc/library/inspect.rst
==============================================================================
--- python/trunk/Doc/library/inspect.rst	(original)
+++ python/trunk/Doc/library/inspect.rst	Sun Sep 13 18:46:19 2009
@@ -567,6 +567,11 @@
 
    Return the frame object for the caller's stack frame.
 
+   This function relies on Python stack frame support in the interpreter, which
+   isn't guaranteed to exist in all implementations of Python. If running in
+   an implmentation without Python stack frame support this function returns
+   ``None``.
+
 
 .. function:: stack([context])
 

Modified: python/trunk/Doc/library/sys.rst
==============================================================================
--- python/trunk/Doc/library/sys.rst	(original)
+++ python/trunk/Doc/library/sys.rst	Sun Sep 13 18:46:19 2009
@@ -417,7 +417,8 @@
    that is deeper than the call stack, :exc:`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.
+   This function should be used for internal and specialized purposes only. It
+   is not guaranteed to exist in all implementations of Python.
 
 
 .. function:: getprofile()