Doctests #165
Merged
Doctests #165
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.