[Python-checkins] Fix doctest doc examples for syntax errors (GH-28486)

pablogsal webhook-mailer at python.org
Wed Sep 29 07:44:48 EDT 2021


https://github.com/python/cpython/commit/f76889a88720b56c8174f26a20a8e676a460c7a6
commit: f76889a88720b56c8174f26a20a8e676a460c7a6
branch: main
author: andrei kulakov <andrei.avk at gmail.com>
committer: pablogsal <Pablogsal at gmail.com>
date: 2021-09-29T12:44:43+01:00
summary:

Fix doctest doc examples for syntax errors (GH-28486)

* fix doctest doc examples for syntax errors

* updated examples to use TypeErrors

* fixed first sentence

* unneeded comma

files:
M Doc/library/doctest.rst

diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index a77322f83acbd..0bbb640bea26b 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -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:



More information about the Python-checkins mailing list