From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 1 Nov 2024 19:36:51 +0000 (+0100)
Subject: [3.12] Docs: make a tutorial example more precise (GH-125066) (GH-125079)
X-Git-Tag: v3.12.8~126
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=479e366ce3b61a33a13e1b94b70cd5395710569b;p=thirdparty%2FPython%2Fcpython.git

[3.12] Docs: make a tutorial example more precise (GH-125066) (GH-125079)

Docs: make a tutorial example more precise (GH-125066)

Based on discussion here:

(cherry picked from commit 6e3c70c61bf961e55e9912a31ca11f61c8e2cd0c)


https: //discuss.python.org/t/omission-in-the-documentation/66816

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
---

diff --git a/Doc/tutorial/introduction.rst b/Doc/tutorial/introduction.rst
index 054bac59c955..65e3b1938bca 100644
--- a/Doc/tutorial/introduction.rst
+++ b/Doc/tutorial/introduction.rst
@@ -197,21 +197,19 @@ and workarounds.
 String literals can span multiple lines.  One way is using triple-quotes:
 ``"""..."""`` or ``'''...'''``.  End of lines are automatically
 included in the string, but it's possible to prevent this by adding a ``\`` at
-the end of the line.  The following example::
-
-   print("""\
+the end of the line.  In the following example, the initial newline is not
+included::
+
+   >>> print("""\
+   ... Usage: thingy [OPTIONS]
+   ...      -h                        Display this usage message
+   ...      -H hostname               Hostname to connect to
+   ... """)
    Usage: thingy [OPTIONS]
         -h                        Display this usage message
         -H hostname               Hostname to connect to
-   """)
-
-produces the following output (note that the initial newline is not included):
 
-.. code-block:: text
-
-   Usage: thingy [OPTIONS]
-        -h                        Display this usage message
-        -H hostname               Hostname to connect to
+   >>>
 
 Strings can be concatenated (glued together) with the ``+`` operator, and
 repeated with ``*``::