Skip to content

Commit 53effa7

Browse files
authored
DOC: update README.md
1 parent 90ac42a commit 53effa7

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Floating-point aware, human readable, numpy-compatible doctesting.
22

3+
# TL;DR
4+
5+
This project extends the standard library `doctest` module to allow flexibility
6+
and easy customization of finding, parsing and checking code examples in
7+
documentation.
8+
9+
Can be used either as drop-in `doctest` replacement or through the `pytest`
10+
integration. Uses a floating-point aware doctest checker by default.
11+
312
## Motivation and scope
413

514
Having examples in the documentation is great. Having wrong examples in the

0 commit comments

Comments
 (0)