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: pathlib: reword docs for stat()
Type: Stage: resolved
Components: Documentation Versions: Python 3.9, Python 3.8, Python 3.7, Python 3.6, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: brett.cannon, docs@python, miss-islington, mmaswg, ned.deily
Priority: normal Keywords: patch

Created on 2020-03-01 10:27 by mmaswg, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 18719 merged mmaswg, 2020-03-01 10:38
PR 18782 merged miss-islington, 2020-03-04 22:52
PR 18783 merged miss-islington, 2020-03-04 22:53
Messages (7)
msg363052 - (view) Author: Swgmma (mmaswg) * Date: 2020-03-01 10:27
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.
msg363400 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2020-03-04 22:51
New changeset 67152d0ed670227b61b5df683655b196ab04ca1a by Brett Cannon in branch 'master':
bpo-39808: Improve docs for pathlib.Path.stat() (GH-18719)
https://github.com/python/cpython/commit/67152d0ed670227b61b5df683655b196ab04ca1a
msg363401 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2020-03-04 22:52
Thanks!
msg363404 - (view) Author: miss-islington (miss-islington) Date: 2020-03-04 23:17
New changeset 6bb67452d4f21e2d948dafce7644b1d66e5efcb8 by Miss Islington (bot) in branch '3.7':
[3.7] bpo-39808: Improve docs for pathlib.Path.stat() (GH-18719) (GH-18782)
https://github.com/python/cpython/commit/6bb67452d4f21e2d948dafce7644b1d66e5efcb8
msg363445 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2020-03-05 18:36
Thanks, swgmma!
msg363446 - (view) Author: miss-islington (miss-islington) Date: 2020-03-05 18:37
New changeset 7b39c474e4ce7057a9e16b06d40261ff563b1e9d by Miss Islington (bot) in branch '3.8':
[3.8] bpo-39808: Improve docs for pathlib.Path.stat() (GH-18719) (GH-18783)
https://github.com/python/cpython/commit/7b39c474e4ce7057a9e16b06d40261ff563b1e9d
msg363809 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2020-03-10 07:48
New changeset c157edb73b234409263ca0d7b6b41ad5f0b455d6 by Ned Deily (Miss Islington (bot)) in branch '3.7':
[3.7] bpo-39808: Improve docs for pathlib.Path.stat() (GH-18719) (GH-18782)
https://github.com/python/cpython/commit/c157edb73b234409263ca0d7b6b41ad5f0b455d6
History
Date User Action Args
2022-04-11 14:59:27adminsetgithub: 83989
2020-03-10 07:48:53ned.deilysetnosy: + ned.deily
messages: + msg363809
2020-03-05 18:37:01miss-islingtonsetmessages: + msg363446
2020-03-05 18:36:38brett.cannonsetmessages: + msg363445
2020-03-04 23:17:46miss-islingtonsetmessages: + msg363404
2020-03-04 22:53:02miss-islingtonsetpull_requests: + pull_request18142
2020-03-04 22:52:54miss-islingtonsetnosy: + miss-islington

pull_requests: + pull_request18141
2020-03-04 22:52:29brett.cannonsetstatus: open -> closed
resolution: fixed
messages: + msg363401

stage: patch review -> resolved
2020-03-04 22:51:57brett.cannonsetnosy: + brett.cannon
messages: + msg363400
2020-03-01 10:38:17mmaswgsetkeywords: + patch
stage: patch review
pull_requests: + pull_request18076
2020-03-01 10:27:01mmaswgcreate