This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Circular reference in Index for frame
Type: Stage:
Components: Documentation Versions: Python 2.2
process
Status: closed Resolution: out of date
Dependencies: Superseder:
Assigned To: fdrake Nosy List: brett.cannon, fdrake, noah
Priority: normal Keywords:

Created on 2002-05-11 03:36 by noah, last changed 2022-04-10 16:05 by admin. This issue is now closed.

Messages (3)
msg10724 - (view) Author: Noah Spurrier (noah) Date: 2002-05-11 03:36
I hope you don't mind all my anal retentive 
documentation bugs ;-)

In the Python Library Index:
    
http://www.python.org/dev/doc/devel/lib/genindex.html

Go to 'F' and look up 'frame object'.
http://www.python.org/dev/doc/devel/lib/module-
signal.html#l2h-1870

It takes you to the signal documentation here:

    "The handler is called with two arguments: 
    the signal number and the current stack frame
    (None or a frame object; see the reference manual
    for a description of frame objects)."

Besides this circular reference, as far as I can
tell the frame object and it's use in a signal handler
is undocumented.

Frame Objects are mentioned in the Python Reference 
Manual Index, but the named anchor is not correct.
It does link to the correct page, but it brings you
to the top of the page, whereas Frame Objects are not
mentioned until much farther down the page. This is
the link given in the Index:
    
http://www.python.org/dev/doc/devel/ref/types.html#l2h-
59

The details of Frame Objects are still rather fuzzy.

Yours,
Noah
msg10725 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2003-05-17 02:28
Logged In: YES 
user_id=357491

The use of the frame object is up to you.  Most people would use it to 
inspect the frame to see where they were when the signal was raised.  Since 
the use is completely up to the user it is not specified.
msg10726 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2003-07-21 16:20
Logged In: YES 
user_id=3066

1. The use of a frame object is an application issue; the
documentation should tell you what it is.
2. The link was indeed wrong due to problems with our
configuration of the tools we use; this has been fixed.
3. If you still think to docs on frame objects are fuzzy,
please explain what didn't make sense in a new bug report.

Closing this report.
History
Date User Action Args
2022-04-10 16:05:18adminsetgithub: 36588
2002-05-11 03:36:54noahcreate