classification
Title: Inherited docstrings for pathlib classes are confusing
Type: enhancement Stage: needs patch
Components: Documentation, Library (Lib) Versions: Python 3.7, Python 3.6
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, pitrou
Priority: normal Keywords: easy

Created on 2017-11-07 19:05 by eric.araujo, last changed 2017-11-08 09:32 by serhiy.storchaka.

Messages (1)
msg305788 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2017-11-07 19:05
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.
History
Date User Action Args
2017-11-08 09:32:03serhiy.storchakasetnosy: + docs@python, pitrou

components: + Documentation
assignee: docs@python
2017-11-07 19:05:43eric.araujocreate