diff options
author | Shantanu <12621235+hauntsaninja@users.noreply.github.com> | 2022-12-24 20:22:49 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-12-24 20:22:49 (GMT) |
commit | 046cbc2080360b0b0bbe6ea7554045a6bbbd94bd (patch) | |
tree | 9564c480fe685187113ad426784a4616b5ef4e80 | |
parent | efccd04b9efc1752a845b377399d2068b06d04e7 (diff) | |
download | cpython-046cbc2080360b0b0bbe6ea7554045a6bbbd94bd.zip cpython-046cbc2080360b0b0bbe6ea7554045a6bbbd94bd.tar.gz cpython-046cbc2080360b0b0bbe6ea7554045a6bbbd94bd.tar.bz2 |
gh-100472: Fix docs claim that compileall parameters could be bytes (#100473)
-rw-r--r-- | Doc/library/compileall.rst | 4 | ||||
-rw-r--r-- | Misc/NEWS.d/next/Documentation/2022-12-23-21-42-26.gh-issue-100472.NNixfO.rst | 1 |
2 files changed, 3 insertions, 2 deletions
diff --git a/Doc/library/compileall.rst b/Doc/library/compileall.rst index 7af46cf..180f5b8 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 0000000..4f41621 --- /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`. |