From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Wed, 15 Jan 2025 14:27:27 +0000 (+0100)
Subject: [3.13] gh-67206: Document that `string.printable` is not printable in the POSIX sense... 
X-Git-Tag: v3.13.2~100
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=639e0f36affa412ab619098298df4429a860a1c9;p=thirdparty%2FPython%2Fcpython.git

[3.13] gh-67206: Document that `string.printable` is not printable in the POSIX sense (GH-128820) (#128868)

gh-67206: Document that `string.printable` is not printable in the POSIX sense (GH-128820)
(cherry picked from commit d906bde250d59c396d8dab92285b832c66cdec27)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
---

diff --git a/Doc/library/string.rst b/Doc/library/string.rst
index 913672a3ff22..09165c481b24 100644
--- a/Doc/library/string.rst
+++ b/Doc/library/string.rst
@@ -59,11 +59,18 @@ The constants defined in this module are:
    String of ASCII characters which are considered punctuation characters
    in the ``C`` locale: ``!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~``.
 
+
 .. data:: printable
 
-   String of ASCII characters which are considered printable.  This is a
-   combination of :const:`digits`, :const:`ascii_letters`, :const:`punctuation`,
-   and :const:`whitespace`.
+   String of ASCII characters which are considered printable by Python.
+   This is a combination of :const:`digits`, :const:`ascii_letters`,
+   :const:`punctuation`, and :const:`whitespace`.
+
+   .. note::
+
+      By design, :meth:`string.printable.isprintable() <str.isprintable>`
+      returns :const:`False`. In particular, ``string.printable`` is not
+      printable in the POSIX sense (see :manpage:`LC_CTYPE <locale(5)>`).
 
 
 .. data:: whitespace
diff --git a/Misc/NEWS.d/next/Documentation/2025-01-14-11-06-41.gh-issue-67206.LYKmi5.rst b/Misc/NEWS.d/next/Documentation/2025-01-14-11-06-41.gh-issue-67206.LYKmi5.rst
new file mode 100644
index 000000000000..11fb617e98ed
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2025-01-14-11-06-41.gh-issue-67206.LYKmi5.rst
@@ -0,0 +1,3 @@
+Document that :const:`string.printable` is not printable in the POSIX sense.
+In particular, :meth:`string.printable.isprintable() <str.isprintable>` returns
+:const:`False`. Patch by Bénédikt Tran.