summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Zipperer <47086307+zipperer@users.noreply.github.com>2024-05-02 05:37:12 (GMT)
committerGitHub <noreply@github.com>2024-05-02 05:37:12 (GMT)
commita6b610a94bee0e4436aee2825c14f05ec2f22f75 (patch)
treec9c2ec28f17315a26956e9ff866d86b36dd40f48
parenta37b0932285b5e883b13a46ff2a32f15d7339894 (diff)
downloadcpython-a6b610a94bee0e4436aee2825c14f05ec2f22f75.zip
cpython-a6b610a94bee0e4436aee2825c14f05ec2f22f75.tar.gz
cpython-a6b610a94bee0e4436aee2825c14f05ec2f22f75.tar.bz2
docs: typo: tiny grammar change: "pointed by" -> "pointed to by" (#118411)
* docs: tiny grammar change: "pointed by" -> "pointed to by" This commit uses "file pointed to by" to replace "file pointed by" in - doc for shutil.copytree - docstring for shutil.copytree - docstring _abc.PathBase.open - docstring for pathlib.Path.open - doc for os.copy_file_range - doc for os.splice The docs use "file pointed to by" more frequently than "file pointed by". So, this commit replaces the uses of "file pointed by" in order to make the uses consistent through the docs. ```bash $ grep -ri 'pointed to by' cpython/ ``` yields more results than ```bash $ grep -ri 'pointed by' cpython/ ``` Separately: There are two occurrences of "tree pointed by": - cpython/Doc/library/xml.etree.elementtree.rst for `xml.etree.ElementInclude.include` - cpython/Lib/xml/etree/ElementInclude.py for `include` For those uses of "tree pointed by", I expect "tree pointed to by" instead. However, I found enough uses online of (a) "tree pointed by" rather than (b) "tree pointed to by" to convince me that (a) is in common use. So, this commit does not replace those occurrences of "tree pointed by" to "tree pointed to by". But I will replace them if a reviewer believes it is correct to replace them. * docs: typo: "exists and executable" -> "exists and is executable" --------- Co-authored-by: Andrew-Zipperer <atzipperer@gmail.com>
-rw-r--r--Doc/library/os.rst4
-rw-r--r--Doc/library/shutil.rst4
-rw-r--r--Lib/pathlib/__init__.py2
-rw-r--r--Lib/pathlib/_abc.py2
-rw-r--r--Lib/shutil.py2
5 files changed, 7 insertions, 7 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 06ec7da..844b5f2 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -926,7 +926,7 @@ as internal buffering of data.
If *offset_src* is None, then *src* is read from the current position;
respectively for *offset_dst*.
- In Linux kernel older than 5.3, the files pointed by *src* and *dst*
+ In Linux kernel older than 5.3, the files pointed to by *src* and *dst*
must reside in the same filesystem, otherwise an :exc:`OSError` is
raised with :attr:`~OSError.errno` set to :const:`errno.EXDEV`.
@@ -1720,7 +1720,7 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
At least one of the file descriptors must refer to a pipe. If *offset_src*
is None, then *src* is read from the current position; respectively for
*offset_dst*. The offset associated to the file descriptor that refers to a
- pipe must be ``None``. The files pointed by *src* and *dst* must reside in
+ pipe must be ``None``. The files pointed to by *src* and *dst* must reside in
the same filesystem, otherwise an :exc:`OSError` is raised with
:attr:`~OSError.errno` set to :const:`errno.EXDEV`.
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 542d288..331acfc 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -242,7 +242,7 @@ Directory and files operations
be copied as far as the platform allows; if false or omitted, the contents
and metadata of the linked files are copied to the new tree.
- When *symlinks* is false, if the file pointed by the symlink doesn't
+ When *symlinks* is false, if the file pointed to by the symlink doesn't
exist, an exception will be added in the list of errors raised in
an :exc:`Error` exception at the end of the copy process.
You can set the optional *ignore_dangling_symlinks* flag to true if you
@@ -447,7 +447,7 @@ Directory and files operations
called. If no *cmd* would be called, return ``None``.
*mode* is a permission mask passed to :func:`os.access`, by default
- determining if the file exists and executable.
+ determining if the file exists and is executable.
*path* is a "``PATH`` string" specifying the lookup directory list. When no
*path* is specified, the results of :func:`os.environ` are used, returning
diff --git a/Lib/pathlib/__init__.py b/Lib/pathlib/__init__.py
index f03f317..8eecf2c 100644
--- a/Lib/pathlib/__init__.py
+++ b/Lib/pathlib/__init__.py
@@ -540,7 +540,7 @@ class Path(_abc.PathBase, PurePath):
def open(self, mode='r', buffering=-1, encoding=None,
errors=None, newline=None):
"""
- Open the file pointed by this path and return a file object, as
+ Open the file pointed to by this path and return a file object, as
the built-in open() function does.
"""
if "b" not in mode:
diff --git a/Lib/pathlib/_abc.py b/Lib/pathlib/_abc.py
index 05698d5..c7e8e2f 100644
--- a/Lib/pathlib/_abc.py
+++ b/Lib/pathlib/_abc.py
@@ -637,7 +637,7 @@ class PathBase(PurePathBase):
def open(self, mode='r', buffering=-1, encoding=None,
errors=None, newline=None):
"""
- Open the file pointed by this path and return a file object, as
+ Open the file pointed to by this path and return a file object, as
the built-in open() function does.
"""
raise UnsupportedOperation(self._unsupported_msg('open()'))
diff --git a/Lib/shutil.py b/Lib/shutil.py
index 910d6b6..c9b4da3 100644
--- a/Lib/shutil.py
+++ b/Lib/shutil.py
@@ -556,7 +556,7 @@ def copytree(src, dst, symlinks=False, ignore=None, copy_function=copy2,
If the optional symlinks flag is true, symbolic links in the
source tree result in symbolic links in the destination tree; if
it is false, the contents of the files pointed to by symbolic
- links are copied. If the file pointed by the symlink doesn't
+ links are copied. If the file pointed to by the symlink doesn't
exist, an exception will be added in the list of errors raised in
an Error exception at the end of the copy process.