[Python-bugs-list] [ python-Bugs-554750 ] Circular reference in Index for frame

[SourceForge.net]

Bugs item #554750, was opened at 2002-05-10 23:36
Message generated for change (Comment added) made by fdrake
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=554750&group_id=5470

Category: Documentation
Group: Python 2.2.1
>Status: Closed
>Resolution: Out of Date
Priority: 5
Submitted By: Noah Spurrier (noah)
Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: Circular reference in Index for frame

Initial Comment:
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


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

>Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2003-07-21 12:20

Message:
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.

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

Comment By: Brett Cannon (bcannon)
Date: 2003-05-16 22:28

Message:
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.

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

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