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: Fuzziness in inspect module documentatio
Type: Stage:
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: fdrake Nosy List: fdrake, pinard
Priority: normal Keywords:

Created on 2002-06-01 14:03 by pinard, last changed 2022-04-10 16:05 by admin. This issue is now closed.

Messages (2)
msg11003 - (view) Author: Franc,ois Pinard (pinard) Date: 2002-06-01 14:03
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.
msg11004 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2004-01-01 07:23
Logged In: YES 
user_id=3066

Fixed in Doc/lib/libinspect.tex revisions 1.15, 1.13.10.2.
History
Date User Action Args
2022-04-10 16:05:22adminsetgithub: 36682
2002-06-01 14:03:14pinardcreate