]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
gh-91317: Document that Path does not collapse initial `//` (GH-32193)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 10 Jun 2022 23:07:19 +0000 (16:07 -0700)
committerGitHub <noreply@github.com>
Fri, 10 Jun 2022 23:07:19 +0000 (16:07 -0700)
commit3a202de3bba88cea8f6f1425e69e66ca755b351c
treef5e66146c41fbcf9b4c2c8d8a200d7082556cde9
parentf9d0240db809fbb4443dc8f96a18e4c49af3fb7f
gh-91317: Document that Path does not collapse initial `//` (GH-32193)

Documentation for `pathlib` says:

> Spurious slashes and single dots are collapsed, but double dots ('..') are not, since this would change the meaning of a path in the face of symbolic links:

However, it omits that initial double slashes also aren't collapsed.

Later, in documentation of `PurePath.drive`, `PurePath.root`, and `PurePath.name` it mentions UNC but:

- this abbreviation says nothing to a person who is unaware about existence of UNC (Wikipedia doesn't help either by [giving a disambiguation page](https://en.wikipedia.org/wiki/UNC))
- it shows up only if a person needs to use a specific property or decides to fully learn what the module provides.

For context, see the BPO entry.
(cherry picked from commit 78f1a436949209dab1f4a9d04036a1a42b165086)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
Doc/library/pathlib.rst
Misc/NEWS.d/next/Documentation/2022-03-30-17-56-01.bpo-47161.gesHfS.rst [new file with mode: 0644]