improved and added docstrings #79
Merged
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 #79 +/- ##
=======================================
Coverage 72.82% 72.82%
=======================================
Files 10 10
Lines 357 357
=======================================
Hits 260 260
Misses 97 97 ☔ View full report in Codecov by Sentry. |
jschepers
reviewed
Feb 19, 2024
jschepers
reviewed
Feb 19, 2024
jschepers
reviewed
Feb 19, 2024
jschepers
reviewed
Feb 19, 2024
jschepers
reviewed
Feb 19, 2024
There was a problem hiding this comment.
@behinger Thank you for adding the doc strings. I mainly made suggestions regarding formatting. But I also added a few remarks/questions. Another thing that I noticed is that there are nearly no examples for input and corresponding output in the doc strings. But we could also postpone this to later.
Please let me know if you have any questions.
Co-authored-by: Judith Schepers <[email protected]>
Co-authored-by: Judith Schepers <[email protected]>
|
I think I adressed everything. nice catches!! |
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.
Sorry Judith :S
can you review please?