Skip to content

Commit 7647436

Browse files
committed
Update the testing section
1 parent e9980eb commit 7647436

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1391,14 +1391,25 @@ ESRI White Paper](http://downloads.esri.com/support/whitepapers/ao_/J9749_MultiP
13911391

13921392
# Testing
13931393

1394-
The testing framework is doctest, which are located in this file README.md.
1394+
The testing framework is pytest, and the tests are located in test_shapefile.py.
1395+
This includes an extensive set of unit tests of the various pyshp features,
1396+
and tests against various input data. Some of the tests that require
1397+
internet connectivity will be skipped in offline testing environments.
1398+
In the same folder as README.md and shapefile.py, from the command line run
1399+
```
1400+
$ python -m pytest
1401+
```
1402+
1403+
Additionally, all the code and examples located in this file, README.md,
1404+
is tested and verified with the builtin doctest framework.
1405+
A special routine for invoking the doctest is run when calling directly on shapefile.py.
13951406
In the same folder as README.md and shapefile.py, from the command line run
13961407
```
13971408
$ python shapefile.py
13981409
```
13991410

14001411
Linux/Mac and similar platforms will need to run `$ dos2unix README.md` in order
1401-
correct line endings in README.md.
1412+
to correct line endings in README.md.
14021413

14031414
# Contributors
14041415

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)