fix: consistent doc string wrapping #116
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
beckermr
commented
Sep 9, 2024
Comment on lines
32
to
-35
| def __init__(self, value): | ||
| """ | ||
| :param value: The measure of the unit in radians. | ||
| """ |
There was a problem hiding this comment.
The init should not have a doc string per normal python conventions.
beckermr
changed the title
CodSpeed Performance ReportMerging #116 will degrade performances by 30.89%Comparing Summary
Benchmarks breakdown
|
beckermr
commented
Sep 9, 2024
| @@ -213,15 +207,8 @@ def xValue(self, *args, **kwargs): | |||
| pos = parse_pos_args(args, kwargs, "x", "y") | |||
| return self._xValue(pos) | |||
|
|
|||
| @implements(_galsim.GSObject._xValue) | |||
There was a problem hiding this comment.
There are a few formally private but clearly public-facing methods like this one that I went ahead and wrapped.
ismael-mendoza
approved these changes
Sep 10, 2024
Co-authored-by: Ismael Mendoza <[email protected]>
Co-authored-by: Ismael Mendoza <[email protected]>
Co-authored-by: Ismael Mendoza <[email protected]>
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 PR ensures we are using consistent doc string wrapping via the
implementsdecorator.I have only wrapped public functions/methods except for a few cases where things were private but clearly meant to be more public facing.
closes #71