Changes by R. David Murray rdmur...@bitdance.com:
--
assignee: docs@python - r.david.murray
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue10960
___
R. David Murray rdmur...@bitdance.com added the comment:
Thanks.
Committed a modified version of the patch in r88164. I extended your breakout
of the attributes to the other paragraphs, and reorganized the order of the
paragraphs in the stat docs to put things into a more logical order (I
R. David Murray rdmur...@bitdance.com added the comment:
I don't think Georg considers it a bug in Sphinx, it's just how the
disambiguation machinery works. You can write :func:`~os.stat` if you want the
link text to just be 'stat' but the link to be to 'os.stat'.
I don't think the addition
Michal Nowikowski godf...@gmail.com added the comment:
The patch v2:
- in description of os.stat function added information about following symlinks,
- made list of returned attributes by os.stat function more readable,
- fixed links to os.stat function in whole document.
--
Added file:
Марк Коренберг socketp...@gmail.com added the comment:
Yes, os.stat and os.lstat should be one after next in docs. Also IMHO, they
should have cross-references. See excellent php docs for example.
--
___
Python tracker rep...@bugs.python.org
godfryd godf...@gmail.com added the comment:
I improved a little bit lstat function description and added note to stat
function.
I see that links :func:`stat` do not lead to stat function but to stat module.
Is it Sphinx bug? In my changes I made explicit link to os.stat function.
R. David Murray rdmur...@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
New submission from Марк Коренберг socketp...@gmail.com:
Documentation should say about 'following symlink' in this function.
Documentation should advice to use os.lstat() in case when it needed.
--
assignee: docs@python
components: Documentation
messages: 126631
nosy: docs@python,
