[Python-checkins] Fix `PurePath.relative_to` links in the pathlib documentation. (GH-93268)
brettcannon
webhook-mailer at python.org
Tue Jun 7 14:54:20 EDT 2022
https://github.com/python/cpython/commit/8ef7929baffd0038bcb38978a6a91ecc63bf0de2
commit: 8ef7929baffd0038bcb38978a6a91ecc63bf0de2
branch: main
author: jacksonriley <52106215+jacksonriley at users.noreply.github.com>
committer: brettcannon <brett at python.org>
date: 2022-06-07T11:54:16-07:00
summary:
Fix `PurePath.relative_to` links in the pathlib documentation. (GH-93268)
These are currently broken as they refer to :meth:`Path.relative_to` rather than :meth:`PurePath.relative_to`, and `relative_to` is a method on `PurePath`.
files:
M Doc/library/pathlib.rst
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index e16097d00f60f..3b401fbaee839 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -1265,7 +1265,7 @@ Below is a table mapping various :mod:`os` functions to their corresponding
:func:`os.link` :meth:`Path.hardlink_to`
:func:`os.symlink` :meth:`Path.symlink_to`
:func:`os.readlink` :meth:`Path.readlink`
-:func:`os.path.relpath` :meth:`Path.relative_to` [#]_
+:func:`os.path.relpath` :meth:`PurePath.relative_to` [#]_
:func:`os.stat` :meth:`Path.stat`,
:meth:`Path.owner`,
:meth:`Path.group`
@@ -1280,4 +1280,4 @@ Below is a table mapping various :mod:`os` functions to their corresponding
.. rubric:: Footnotes
.. [#] :func:`os.path.abspath` normalizes the resulting path, which may change its meaning in the presence of symlinks, while :meth:`Path.absolute` does not.
-.. [#] :meth:`Path.relative_to` requires ``self`` to be the subpath of the argument, but :func:`os.path.relpath` does not.
+.. [#] :meth:`PurePath.relative_to` requires ``self`` to be the subpath of the argument, but :func:`os.path.relpath` does not.
More information about the Python-checkins
mailing list