Fuzziness in inspect module documentatio

[pinard]

BPO	563298
Nosy	@freddrake

^{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 2004-01-01.07:23:07.000>
created_at = <Date 2002-06-01.14:03:14.000>
labels = ['docs']
title = 'Fuzziness in inspect module documentatio'
updated_at = <Date 2004-01-01.07:23:07.000>
user = 'https://bugs.python.org/pinard'

bugs.python.org fields:

activity = <Date 2004-01-01.07:23:07.000>
actor = 'fdrake'
assignee = 'fdrake'
closed = True
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2002-06-01.14:03:14.000>
creator = 'pinard'
dependencies = []
files = []
hgrepos = []
issue_num = 563298
keywords = []
message_count = 2.0
messages = ['11003', '11004']
nosy_count = 2.0
nosy_names = ['fdrake', 'pinard']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue563298'
versions = []

[pinard]

Hello, Fred.

I'm looking at Web pages about the inspect' module, and more precisely inspect-stack.html'. The text speaks about "higher"
and "lower", "above"
and "below", and this is ambiguous as people would draw
the stack top up,
and other would draw the stack top down. Do you agree
that this could
be clarified?

The text could rather stick with words like "recent" or
"older", or "near
the top" or "away from the top", maybe. Beware that
the word "deeper"
is ambiguous too. Or else, the text could explain the
drawing convention
for stacks used in the text, so people could interpret
what is written.

One might try to guess the drawing conventions from the
fact functions have
"outer" and "inner" in their name, but this is too
difficult.

Maybe the text could use "outer" and "inner" more
systematically, all over?
It would most probably create more clarity.

[freddrake]

Logged In: YES
user_id=3066

Fixed in Doc/lib/libinspect.tex revisions 1.15, 1.13.10.2.