Circular reference in Index for frame

[noah]

BPO	554750
Nosy	@freddrake, @brettcannon

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/freddrake'
closed_at = <Date 2003-07-21.16:20:09.000>
created_at = <Date 2002-05-11.03:36:54.000>
labels = ['docs']
title = 'Circular reference in Index for frame'
updated_at = <Date 2003-07-21.16:20:09.000>
user = 'https://bugs.python.org/noah'

bugs.python.org fields:

activity = <Date 2003-07-21.16:20:09.000>
actor = 'fdrake'
assignee = 'fdrake'
closed = True
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2002-05-11.03:36:54.000>
creator = 'noah'
dependencies = []
files = []
hgrepos = []
issue_num = 554750
keywords = []
message_count = 3.0
messages = ['10724', '10725', '10726']
nosy_count = 3.0
nosy_names = ['fdrake', 'brett.cannon', 'noah']
pr_nums = []
priority = 'normal'
resolution = 'out of date'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue554750'
versions = ['Python 2.2']

[noah]

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

[brettcannon]

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.

[freddrake]

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.