[issue31972] Inherited docstrings for pathlib classes are confusing

[Éric Araujo]

Éric Araujo  added the comment:

Thanks for the patch!

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[Éric Araujo]

Change by Éric Araujo :


--
assignee: docs@python -> eric.araujo
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed
versions: +Python 3.8

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[miss-islington]

miss-islington  added the comment:


New changeset 19b7f6694af56a1c9fdc0f1f9fc09ae48439ab4c by Miss Islington (bot) 
in branch '3.7':
bpo-31972: Improve docstrings for pathlib classes (GH-5310)
https://github.com/python/cpython/commit/19b7f6694af56a1c9fdc0f1f9fc09ae48439ab4c


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[miss-islington]

miss-islington  added the comment:


New changeset 5c81ed49412e41a671283cdb4c297dab52f5b7c5 by Miss Islington (bot) 
in branch '3.6':
bpo-31972: Improve docstrings for pathlib classes (GH-5310)
https://github.com/python/cpython/commit/5c81ed49412e41a671283cdb4c297dab52f5b7c5


--
nosy: +miss-islington

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[miss-islington]

Change by miss-islington :


--
pull_requests: +5524

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[miss-islington]

Change by miss-islington :


--
pull_requests: +5523

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[Éric Araujo]

Éric Araujo  added the comment:


New changeset dfa015cf77a148d229ddc0a5b063562c9f9664f2 by Éric Araujo (chason) 
in branch 'master':
bpo-31972: Improve docstrings for pathlib classes (#5310)
https://github.com/python/cpython/commit/dfa015cf77a148d229ddc0a5b063562c9f9664f2


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[Chason Chaffin]

Change by Chason Chaffin :


--
nosy: +chason

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[Chason Chaffin]

Change by Chason Chaffin :


--
pull_requests: +5157

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[Serhiy Storchaka]

Change by Serhiy Storchaka :


--
pull_requests:  -4645

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[Pablo Galindo Salgado]

Change by Pablo Galindo Salgado :


--
pull_requests: +4645

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[Éric Araujo]

Change by Éric Araujo :


--
pull_requests:  -4644

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[Pablo Galindo Salgado]

Change by Pablo Galindo Salgado :


--
keywords: +patch
pull_requests: +4644
stage: needs patch -> patch review

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[Serhiy Storchaka]

Change by Serhiy Storchaka :


--
assignee:  -> docs@python
components: +Documentation
nosy: +docs@python, pitrou

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31972] Inherited docstrings for pathlib classes are confusing

[Éric Araujo]

New submission from Éric Araujo :

pydoc pathlib.Path shows the docstring of PurePath:

 |  PurePath represents a filesystem path and offers operations which
 |  don't imply any actual filesystem I/O.

But immediately after we see methods like chmod, exists and co which obviously 
aren’t pure.  Looking at the reST docs or the source code, the reader can 
deduce that this is the docstring of PurePath inherited by Path, but I find it 
confusing.

Solution: adding docstrings to all pathlib classes.  PurePath and Path can have 
all the info, Posix/Windows* subclasses only one line with a reference.

--
components: Library (Lib)
keywords: easy
messages: 305788
nosy: eric.araujo
priority: normal
severity: normal
stage: needs patch
status: open
title: Inherited docstrings for pathlib classes are confusing
type: enhancement
versions: Python 3.6, Python 3.7

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com