Update model signatures with default parameter values #41
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
Signed-off-by: Conor MacBride <conor@macbride.me>
Signed-off-by: Conor MacBride <conor@macbride.me>
Signed-off-by: Conor MacBride <conor@macbride.me>
Signed-off-by: Conor MacBride <conor@macbride.me>
Codecov Report
@@ Coverage Diff @@
## main #41 +/- ##
==========================================
+ Coverage 94.92% 95.05% +0.12%
==========================================
Files 18 18
Lines 1341 1376 +35
==========================================
+ Hits 1273 1308 +35
Misses 68 68
Continue to review full report at Codecov.
|
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
This PR uses the new
mcalf.utils.collectionsclasses and adds functions for setting the signature of model__init__methods. This update does not change the code, however it now allows for tab completion of parameter names when initialising model classes. It also allows for the default values of the parameters to be automatically documented based on the default value in the code. (Previously the default value had to be specified twice.)