ImagingDataCommons / highdicom

High-level DICOM abstractions for the Python programming language
https://highdicom.readthedocs.io
MIT License
168 stars 35 forks source link

Doctests #165

Closed CPBridge closed 2 years ago

CPBridge commented 2 years ago

Unfortunately #143 has grown stale because changes were required that the contributor (working on their own fork) has not made. Furthermore, there are now conflicts with master.

In order to get these changes in while keeping the contributor's commits in the library for recognition of the contributions, I have taken the commits from the fork and started this new pull request where I have made the changes myself.

Additionally I am updating the github workflows to run doctests automatically.

Partially addresses #126 by testing snippets in docstrings, but does not test the examples in the rst files in such as usage.rst. which are arguably more important. We will probably need a different approach there.