Skip to content

Commit 40d2f0e

Browse files
committed
Signpost better what's the typo that doctest needs to discover
1 parent c7c4051 commit 40d2f0e

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

ch04packaging/04documentation.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@
443443
"source": [
444444
"`doctest` is a module included in the standard library. It runs all the code within the docstrings and checks whether the output is what it's claimed on the documentation.\n",
445445
"\n",
446-
"Let's add an example to our greeting function and check it with `doctest`. We are leaving the output with a small typo to see what's the type of output we get from `doctest`."
446+
"Let's add an example to our greeting function and check it with `doctest`. We are leaving the output with a small typo (missing the close quote `'`) to see what's the type of output we get from `doctest`."
447447
]
448448
},
449449
{

0 commit comments

Comments
 (0)