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: Clarifications for the documentation of pathlib
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.2
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: eli.bendersky Nosy List: eli.bendersky, pitrou, vstinner
Priority: normal Keywords: patch

Created on 2013-11-26 14:34 by eli.bendersky, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue19799.initial.patch eli.bendersky, 2013-11-26 14:35 review
issue19799.2.patch eli.bendersky, 2013-11-27 14:09 review
pathlib-inheritance.png eli.bendersky, 2013-11-27 14:36
Messages (11)
msg204477 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2013-11-26 14:34
Following up from Issue #19673; The initial patch clarifies the use cases of pure vs. concrete paths a bit and adds explicit signatures for the path class constructors (moving the construction discussion under the parent class).

Also, IMHO an inheritance diagram from PEP 428 is very relevant and useful. Would you mind if I add a .png for the pathlib rst doc?
msg204502 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2013-11-26 16:54
> Would you mind if I add a .png for the pathlib rst doc?

No, it sounds ok to me.
msg204581 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2013-11-27 14:09
Attaching a new patch. Hopefully the image will be viewable in the code review tool
msg204582 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2013-11-27 14:11
Just in case it isn't: https://dl.dropboxusercontent.com/u/15602400/images/pathlib-inheritance.png
msg204583 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2013-11-27 14:11
> Hopefully the image will be viewable in the code review tool

Apparently not :)
msg204587 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2013-11-27 14:21
Could you please attach the picture separatly?
msg204590 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2013-11-27 14:37
On Wed, Nov 27, 2013 at 6:21 AM, STINNER Victor <report@bugs.python.org>wrote:

>
> STINNER Victor added the comment:
>
> Could you please attach the picture separatly?
>
>
Done
msg204591 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2013-11-27 14:37
Which tool did you use to draw this schema? You may attach also the source if someone would like to modify it in the future.
msg204592 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2013-11-27 14:44
>
> STINNER Victor added the comment:
>
> Which tool did you use to draw this schema? You may attach also the source
> if someone would like to modify it in the future.
>

Sorry, but there's no source. I drew it graphically. But since I did it
with Google Drive's drawing program, I can just share out a link to the
editor -
https://docs.google.com/drawings/d/1F8do-1WL1sIGkZuiufcxcpZRtS0w4SwAowq-Uamrwt8/edit?usp=sharing

I suppose if someone wants to edit it they can copy the document and do
that.
msg204594 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2013-11-27 15:14
You can export the schema as SVG.
msg204668 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2013-11-28 14:53
Committed in 90b56ec318b6
History
Date User Action Args
2022-04-11 14:57:54adminsetgithub: 63998
2013-11-28 14:53:31eli.benderskysetstatus: open -> closed
versions: + Python 3.2, - Python 3.4, Python 3.5
messages: + msg204668

resolution: fixed
stage: patch review -> resolved
2013-11-27 15:14:47vstinnersetmessages: + msg204594
2013-11-27 14:44:15eli.benderskysetmessages: + msg204592
2013-11-27 14:37:24vstinnersetmessages: + msg204591
2013-11-27 14:37:24eli.benderskysetmessages: + msg204590
2013-11-27 14:36:25eli.benderskysetfiles: + pathlib-inheritance.png
2013-11-27 14:21:04vstinnersetnosy: + vstinner
messages: + msg204587
2013-11-27 14:11:21pitrousetmessages: + msg204583
2013-11-27 14:11:18eli.benderskysetmessages: + msg204582
2013-11-27 14:10:00eli.benderskysetfiles: + issue19799.2.patch

messages: + msg204581
2013-11-26 16:54:44pitrousetmessages: + msg204502
2013-11-26 14:35:32eli.benderskysetfiles: + issue19799.initial.patch
keywords: + patch
2013-11-26 14:34:58eli.benderskycreate