mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-23 03:05:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15

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

Browse source 
* fix doctest doc examples for syntax errors

* updated examples to use TypeErrors

* fixed first sentence

* unneeded comma
This commit is contained in:
andrei kulakov 2021-09-29 07:44:43 -04:00 • committed by GitHub
parent bc4cde4033
commit f76889a887
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

21
Doc/library/doctest.rst
View 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: