Backwards improvement of docstrings for EpiModels #141
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #141 +/- ##
=======================================
Coverage 98.24% 98.24%
=======================================
Files 25 25
Lines 228 228
=======================================
Hits 224 224
Misses 4 4 ☔ View full report in Codecov by Sentry. |
seabbs
force-pushed
the
backwards-improvement-of-docstrings
branch
from
085c4b9 to
97d8224
Compare
|
Doc changes look reasonable but the outstanding is merge conflicts due to the change in submodules and git losing track of the folders on this PR. |
Base automatically changed from
139-document-all-latent-models-and-methods-that-dispatch-on-them-plus-adding-keyword-args-as-required
to
main
March 15, 2024 14:24
seabbs
force-pushed
the
backwards-improvement-of-docstrings
branch
from
97d8224 to
ba2a134
Compare
seabbs
approved these changes
Mar 15, 2024
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.
Goal
Bring improvements in doc string clarity into
AbstractEpiModelsubtype documentation.My view is that the doc string layout for
AbstractLatentModelsubtypes and method dispatching on them was improved compared to #138. This PR aims to include backwards improvement in style for the structs/methods documented in #138 .