Docs: make a tutorial example more precise (#125066)

Based on discussion here:

https://discuss.python.org/t/omission-in-the-documentation/66816
This commit is contained in:
Ned Batchelder 2024-10-07 19:41:13 -04:00 committed by GitHub
parent 447a15190d
commit 6e3c70c61b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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::
the end of the line. In the following example, the initial newline is not
included::
print("""\
>>> 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 ``*``::