From: Barney Gale <barney.gale@gmail.com>
Date: Tue, 23 Jan 2024 01:06:44 +0000 (+0000)
Subject: GH-99334: Explain that `PurePath.is_relative_to()` is purely lexical. (#114031)
X-Git-Tag: v3.13.0a4~369
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3a61d24062aaa1e13ba794360b6c765d9a1f2b06;p=thirdparty%2FPython%2Fcpython.git

GH-99334: Explain that `PurePath.is_relative_to()` is purely lexical. (#114031)
---

diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index b924f470e0be..faff3bc5823c 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -515,6 +515,13 @@ Pure paths provide the following methods and properties:
       >>> p.is_relative_to('/usr')
       False
 
+   This method is string-based; it neither accesses the filesystem nor treats
+   "``..``" segments specially. The following code is equivalent:
+
+      >>> u = PurePath('/usr')
+      >>> u == p or u in p.parents
+      False
+
    .. versionadded:: 3.9
 
    .. deprecated-removed:: 3.12 3.14