Update docstrings, run in CI #240
Merged
Conversation
This file contains hidden or 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
Codecov ReportBase: 76.92% // Head: 76.92% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #240 +/- ##
=======================================
Coverage 76.92% 76.92%
=======================================
Files 4 4
Lines 845 845
=======================================
Hits 650 650
Misses 195 195
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
$ grep -r simtk . | wc -l
0
Collaborator
|
This is great, thanks @mattwthompson |
mikemhenry
approved these changes
Oct 25, 2022
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.
The docstrings in the generators serve as de facto documentation, and a handful of them were significantly out of date. This was a mild frustration while trying to figure out how to hook into some of the internals.
This PR updates the docstrings to run stand-alone and also adds a call to
pytest --doctest-modulesto automate this check and trigger soft failures when they fall out of sync.