[issue39808] pathlib: reword docs for stat()

swgmma report at bugs.python.org
Sun Mar 1 05:27:01 EST 2020


New submission from swgmma <jason.nader at protonmail.com>:

The docs for stat() (https://docs.python.org/3.9/library/pathlib.html#pathlib.Path.stat) state:

> Return information about this path (similarly to os.stat()). The result is looked up at each call to this method."

Nit picks:

1) It states "similarly to os.stat()" which implies there may be differences between the two, when in fact they both return the same `os.stat_result` object.

2) It should mention that `stat()` returns a `os.stat_result` object without having to go digging into the docs for `os` to find out.

----------
assignee: docs at python
components: Documentation
messages: 363052
nosy: docs at python, swgmma
priority: normal
severity: normal
status: open
title: pathlib: reword docs for stat()
versions: Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue39808>
_______________________________________


More information about the Python-bugs-list mailing list