pathlib: reword docs for stat()

[ammgws]

BPO	39808
Nosy	@brettcannon, @ned-deily, @miss-islington, @ammgws
PRs	bpo-39808: Improve docs for pathlib.Path.stat() #18719 [3.7] bpo-39808: Improve docs for pathlib.Path.stat() (GH-18719) #18782 [3.8] bpo-39808: Improve docs for pathlib.Path.stat() (GH-18719) #18783

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2020-03-04.22:52:29.335>
created_at = <Date 2020-03-01.10:27:01.373>
labels = ['3.7', '3.8', '3.9', 'docs']
title = 'pathlib: reword docs for stat()'
updated_at = <Date 2020-03-10.07:48:53.008>
user = 'https://github.com/ammgws'

bugs.python.org fields:

activity = <Date 2020-03-10.07:48:53.008>
actor = 'ned.deily'
assignee = 'docs@python'
closed = True
closed_date = <Date 2020-03-04.22:52:29.335>
closer = 'brett.cannon'
components = ['Documentation']
creation = <Date 2020-03-01.10:27:01.373>
creator = 'swgmma'
dependencies = []
files = []
hgrepos = []
issue_num = 39808
keywords = ['patch']
message_count = 7.0
messages = ['363052', '363400', '363401', '363404', '363445', '363446', '363809']
nosy_count = 5.0
nosy_names = ['brett.cannon', 'ned.deily', 'docs@python', 'miss-islington', 'swgmma']
pr_nums = ['18719', '18782', '18783']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue39808'
versions = ['Python 3.5', 'Python 3.6', 'Python 3.7', 'Python 3.8', 'Python 3.9']

[ammgws]

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.

[brettcannon]

New changeset 67152d0 by Brett Cannon in branch 'master':
bpo-39808: Improve docs for pathlib.Path.stat() (GH-18719)
67152d0

[brettcannon]

Thanks!

[miss-islington]

New changeset 6bb6745 by Miss Islington (bot) in branch '3.7':
[3.7] bpo-39808: Improve docs for pathlib.Path.stat() (GH-18719) (GH-18782)
6bb6745

[brettcannon]

Thanks, swgmma!

[miss-islington]

New changeset 7b39c47 by Miss Islington (bot) in branch '3.8':
[3.8] bpo-39808: Improve docs for pathlib.Path.stat() (GH-18719) (GH-18783)
7b39c47

[ned-deily]

New changeset c157edb by Ned Deily (Miss Islington (bot)) in branch '3.7':
[3.7] bpo-39808: Improve docs for pathlib.Path.stat() (GH-18719) (GH-18782)
c157edb