add section on documentation and duck typing. #509
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
MrJulEnergy
requested changes
Feb 28, 2023
Codecov Report
@@ Coverage Diff @@
## main #509 +/- ##
=======================================
Coverage 96.63% 96.63%
=======================================
Files 34 34
Lines 1663 1663
Branches 601 601
=======================================
Hits 1607 1607
Misses 56 56
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
MrJulEnergy
reviewed
Mar 2, 2023
| @@ -148,7 +148,9 @@ | |||
| "metadata": {}, | |||
| "source": [ | |||
| "The ZnTrack class generates an `__init__` method for all `zn.params` and other inputs automatically.\n", | |||
| "When writing a custom `__init__` it is important to add `super().__init__(**kwargs)` for ZnTrack to work.\n", | |||
| "The generated `__init__()` code will call a method named `_post_init_()` if it exists.\n", | |||
| "You can use override this method to add custom initialization code.\n", | |||
There was a problem hiding this comment.
I don't understand this sentence grammatically
| "When writing a custom `__init__` it is important to add `super().__init__(**kwargs)` for ZnTrack to work.\n", | ||
| "The generated `__init__()` code will call a method named `_post_init_()` if it exists.\n", | ||
| "You can use override this method to add custom initialization code.\n", | ||
| "Alternatively, when writing a custom `__init__` it is important to add `super().__init__(**kwargs)` for ZnTrack to work.\n", |
There was a problem hiding this comment.
perphaps i'm not familiar enough with data classes but it is not clear what the advantage is of writing a custom _init_ over a _post_init_.
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.
No description provided.