add docstrings to all functions #100
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
sroet
requested changes
Feb 13, 2024
src/pytom_tm/weights.py
Outdated
Comment on lines
137
to
138
| shape: tuple[int, int, int] | ||
| shape tuple with x,y or x,y,z dimension |
There was a problem hiding this comment.
shouldn't this then be:
Suggested change
| shape: tuple[int, int, int] | |
| shape tuple with x,y or x,y,z dimension | |
| shape: Union[tuple[int, int, int], tuple[int, int]] | |
| shape tuple with x,y or x,y,z dimension |
and also be fixed in the type hint?
src/pytom_tm/weights.py
Outdated
Comment on lines
163
to
164
| shape: tuple[int, int, int] | ||
| shape tuple with x,y or x,y,z dimension |
There was a problem hiding this comment.
same as above
Suggested change
| shape: tuple[int, int, int] | |
| shape tuple with x,y or x,y,z dimension | |
| shape: Union[tuple[int, int, int], tuple[int, int]] | |
| shape tuple with x,y or x,y,z dimension |
src/pytom_tm/weights.py
Outdated
Comment on lines
196
to
197
| shape: tuple[int, int, int] | ||
| shape tuple with x,y or x,y,z dimension |
There was a problem hiding this comment.
as above
Suggested change
| shape: tuple[int, int, int] | |
| shape tuple with x,y or x,y,z dimension | |
| shape: Union[tuple[int, int, int], tuple[int, int]] | |
| shape tuple with x,y or x,y,z dimension |
src/pytom_tm/weights.py
Outdated
| shape tuple with x,y or x,y,z dimension | ||
| spacing: float | ||
| voxel size in real space | ||
| low_pass: Optional[float] |
There was a problem hiding this comment.
Suggested change
| low_pass: Optional[float] | |
| low_pass: Optional[float], default None |
src/pytom_tm/weights.py
Outdated
| voxel size in real space | ||
| low_pass: Optional[float] | ||
| resolution of low-pass filter | ||
| high_pass: Optional[float] |
There was a problem hiding this comment.
Suggested change
| high_pass: Optional[float] | |
| high_pass: Optional[float], default None |
Co-authored-by: Sander Roet <[email protected]>
|
Thanks for the detailed review. I think its a good idea to add the defaults ! just FYI went through the first suggestions, will continue tonight or tomorrow. |
Co-authored-by: Sander Roet <[email protected]>
sroet
requested changes
Feb 14, 2024
Co-authored-by: Sander Roet <[email protected]>
Co-authored-by: Sander Roet <[email protected]>
|
thanks for the links, yep now they are resolved! |
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.
This is a draft PR to expand and update the docstrings of the code.
This PR expands doscstrings, except for the file correlation.py where I updated some functions to first create an output return variable. In all other files its just docstrings updates.
Closes #8
PR#100 💯