From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sat, 24 Dec 2022 20:29:41 +0000 (-0800)
Subject: gh-100472: Fix docs claim that compileall parameters could be bytes (GH-100473)
X-Git-Tag: v3.10.10~92
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ad8d2ef54ffde39c6d59c4fc6c0e9b8c529b306d;p=thirdparty%2FPython%2Fcpython.git

gh-100472: Fix docs claim that compileall parameters could be bytes (GH-100473)

(cherry picked from commit 046cbc2080360b0b0bbe6ea7554045a6bbbd94bd)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
---

diff --git a/Doc/library/compileall.rst b/Doc/library/compileall.rst
index de34664acb84..b020b71dea5f 100644
--- a/Doc/library/compileall.rst
+++ b/Doc/library/compileall.rst
@@ -198,7 +198,7 @@ Public functions
 
    The *stripdir*, *prependdir* and *limit_sl_dest* arguments correspond to
    the ``-s``, ``-p`` and ``-e`` options described above.
-   They may be specified as ``str``, ``bytes`` or :py:class:`os.PathLike`.
+   They may be specified as ``str`` or :py:class:`os.PathLike`.
 
    If *hardlink_dupes* is true and two ``.pyc`` files with different optimization
    level have the same content, use hard links to consolidate duplicate files.
@@ -268,7 +268,7 @@ Public functions
 
    The *stripdir*, *prependdir* and *limit_sl_dest* arguments correspond to
    the ``-s``, ``-p`` and ``-e`` options described above.
-   They may be specified as ``str``, ``bytes`` or :py:class:`os.PathLike`.
+   They may be specified as ``str`` or :py:class:`os.PathLike`.
 
    If *hardlink_dupes* is true and two ``.pyc`` files with different optimization
    level have the same content, use hard links to consolidate duplicate files.
diff --git a/Misc/NEWS.d/next/Documentation/2022-12-23-21-42-26.gh-issue-100472.NNixfO.rst b/Misc/NEWS.d/next/Documentation/2022-12-23-21-42-26.gh-issue-100472.NNixfO.rst
new file mode 100644
index 000000000000..4f4162150750
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2022-12-23-21-42-26.gh-issue-100472.NNixfO.rst
@@ -0,0 +1 @@
+Remove claim in documentation that the ``stripdir``, ``prependdir`` and ``limit_sl_dest`` parameters of :func:`compileall.compile_dir` and :func:`compileall.compile_file` could be :class:`bytes`.