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

miss-islington webhook-mailer at python.org
Sat Dec 24 15:29:55 EST 2022


https://github.com/python/cpython/commit/f801fa8ee5e6f67481b78cce495a9228d82c81c3
commit: f801fa8ee5e6f67481b78cce495a9228d82c81c3
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-12-24T12:29:50-08:00
summary:

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

(cherry picked from commit 046cbc2080360b0b0bbe6ea7554045a6bbbd94bd)

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

files:
A Misc/NEWS.d/next/Documentation/2022-12-23-21-42-26.gh-issue-100472.NNixfO.rst
M Doc/library/compileall.rst

diff --git a/Doc/library/compileall.rst b/Doc/library/compileall.rst
index 7af46cf32008..180f5b81c2b6 100644
--- a/Doc/library/compileall.rst
+++ b/Doc/library/compileall.rst
@@ -199,7 +199,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.
@@ -269,7 +269,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`.



More information about the Python-checkins mailing list