Finish updating docstrings #232
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 ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #232 +/- ##
==========================================
+ Coverage 92.19% 92.24% +0.04%
==========================================
Files 37 37
Lines 6623 6639 +16
Branches 1590 1590
==========================================
+ Hits 6106 6124 +18
Misses 298 298
+ Partials 219 217 -2 ☔ View full report in Codecov by Sentry. |
KasiaKoz
requested changes
Mar 27, 2024
There was a problem hiding this comment.
Looks good, there are just a couple of small things:
- I think the description of the spatial tree is a bit off right now
- multiprocessing description needs a little ironing in one place, it mentioned
combineas somewhat optional which might give the wrong idea (i think you still need to pass a method, even if that method is an identity map)
I think I left some other comments but those will be mostly just passing thoughts
|
@KasiaKoz bump to avoid this going stale! |
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.
Updated docstrings I missed in #229 and added type hints to methods if they have an associated docstring. Now everything will render nicely in the docs :)