aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2024-10-07 19:41:13 -0400
committerGitHub <noreply@github.com>2024-10-07 19:41:13 -0400
commit6e3c70c61bf961e55e9912a31ca11f61c8e2cd0c (patch)
tree4e70bdddc5fa44a9b3a465a66f338e8b2e0c9136
parent447a15190d6d766004b77619ba43e44256e348e2 (diff)
downloadcpython-6e3c70c61bf961e55e9912a31ca11f61c8e2cd0c.tar.gz
cpython-6e3c70c61bf961e55e9912a31ca11f61c8e2cd0c.zip
Docs: make a tutorial example more precise (#125066)
Based on discussion here: https://discuss.python.org/t/omission-in-the-documentation/66816
-rw-r--r--Doc/tutorial/introduction.rst20
1 files changed, 9 insertions, 11 deletions
diff --git a/Doc/tutorial/introduction.rst b/Doc/tutorial/introduction.rst
index 054bac59c95..65e3b1938bc 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 ``*``::