[docs] [issue10960] os.stat() does not mention that it follow symlinks by default

R. David Murray report at bugs.python.org
Fri Jan 21 23:08:43 CET 2011

R. David Murray <rdmurray at bitdance.com> added the comment:

I almost closed this as invalid, since the name is, after all 'os.stat' and the docs clearly say that it calls the 'stat' system call.  However, I see that our docs do not contain the more explicit language used by the 'stat' system call docs: "stats the file pointed to by path".  Although even that isn't crystal clear unless you also read the definition of 'lstat' right below it.  If you read our docs for lstat it does become clear even as things stand, but lstat isn't right below stat in our docs.

So on reflection I think the docs could use improvement in this area.

nosy: +r.david.murray
stage:  -> needs patch

Python tracker <report at bugs.python.org>

More information about the docs mailing list