From 8688d463c5bfeff814d22b9af2627732430a9c81 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Mon, 7 Oct 2024 19:41:13 -0400 Subject: [PATCH] Docs: make a tutorial example more precise (GH-125066) Based on discussion here: (cherry picked from commit 6e3c70c61bf961e55e9912a31ca11f61c8e2cd0c) Co-authored-by: Ned Batchelder https: //discuss.python.org/t/omission-in-the-documentation/66816 --- Doc/tutorial/introduction.rst | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/Doc/tutorial/introduction.rst b/Doc/tutorial/introduction.rst index 054bac59c955d5..65e3b1938bca9c 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 ``*``::