[Python-bugs-list] [ python-Bugs-563298 ] Fuzziness in inspect module documentatio

[noreply@sourceforge.net]

Bugs item #563298, was opened at 2002-06-01 14:03
You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=563298&group_id=5470

Category: Documentation
Group: Not a Bug
Status: Open
Resolution: None
Priority: 5
Submitted By: Franc,ois Pinard (pinard)
Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: Fuzziness in inspect module documentatio

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


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

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