]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Fix doctest doc examples for syntax errors (GH-28486)
authorandrei kulakov <andrei.avk@gmail.com>
Wed, 29 Sep 2021 11:44:43 +0000 (07:44 -0400)
committerGitHub <noreply@github.com>
Wed, 29 Sep 2021 11:44:43 +0000 (12:44 +0100)
* fix doctest doc examples for syntax errors

* updated examples to use TypeErrors

* fixed first sentence

* unneeded comma

Doc/library/doctest.rst

index a77322f83acbdef19d464ba1d196a700f309defb..0bbb640bea26b1f49abde73ef283d79302c734ad 100644 (file)
@@ -485,25 +485,24 @@ Some details you should read once, but won't need to remember:
 
 .. index:: single: ^ (caret); marker
 
-* For some :exc:`SyntaxError`\ s, Python displays the character position of the
-  syntax error, using a ``^`` marker::
+* For some exceptions, Python displays the position of the error using ``^``
+  markers and tildes::
 
-     >>> 1 1
+     >>> 1 + None
        File "<stdin>", line 1
-         1 1
-           ^
-     SyntaxError: invalid syntax
+         1 + None
+         ~~^~~~~~
+     TypeError: unsupported operand type(s) for +: 'int' and 'NoneType'
 
   Since the lines showing the position of the error come before the exception type
   and detail, they are not checked by doctest.  For example, the following test
   would pass, even though it puts the ``^`` marker in the wrong location::
 
-     >>> 1 1
-     Traceback (most recent call last):
+     >>> 1 + None
        File "<stdin>", line 1
-         1 1
-         ^
-     SyntaxError: invalid syntax
+         1 + None
+         ^~~~~~~~
+     TypeError: unsupported operand type(s) for +: 'int' and 'NoneType'
 
 
 .. _option-flags-and-directives: