DM-29271: PTC task: Refactoring/simplification of code ported from Pierre Astier's repository. #177
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
czwa
approved these changes
Mar 30, 2021
python/lsst/ip/isr/ptcDataset.py
Outdated
| ptcFitParsError=[np.nan], ptcFitChiSq=np.nan, covArray=[], covArrayModel=[], | ||
| covSqrtWeights=[], aMatrix=[], bMatrix=[], covArrayModelNoB=[], aMatrixNoB=[], | ||
| finalVar=[np.nan], finalModelVar=[np.nan], finalMean=[np.nan]): | ||
| """Function to initialize an amp of a PhotonTransferCurveDataset.""" |
There was a problem hiding this comment.
Closing """ should be on a separate line. It might be good to add a note pointing that these parameters are all documented in the class init.
There was a problem hiding this comment.
I think this requirement has been relaxed (to accommodate the on-same-line enforcement in black): https://developer.lsst.io/python/numpydoc.html#docstrings-should-begin-with-and-terminate-with-on-its-own-line
There was a problem hiding this comment.
Thank you both! I'll add the comment that Chris suggests, but keep in mind what Lauren points out.
There was a problem hiding this comment.
I did not know this, so thanks from me as well!
Expand explanation in docstring
plazas
force-pushed
the
tickets/DM-29271
branch
from
9e141c9
to
7cca71d
Compare
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.