New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DM-23195: DM-21221 broke cp_pipe due to lack of tests #26
Conversation
9afb538
to
4784315
Compare
python/lsst/cp/pipe/ptc.py
Outdated
|
||
Returns | ||
------- | ||
dataset : `lsst.cp.pipe.ptc.PhotonTransferCurveDataset` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This dataset
is the same object as the dataset
parameter, but has been modified (right?). Let's document that — rather than just repeating the same words, let's be explicit about what this method changes in that object.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have expanded the docstring with clarifications.
There are actually three separate changes here, and I think it would be helpful to split them into three separate commits:
|
Also, remember the character limit on the first line of commit messages: see our guidelines. |
@@ -354,7 +354,7 @@ def runDataRef(self, dataRef, visitPairs): | |||
lookupTableArray = np.zeros((numberAmps, numberAduValues), dtype=np.float32) | |||
|
|||
# Fit PTC and (non)linearity of signal vs time curve, produce linearizer | |||
self.fitPtcAndNonLinearity(dataset, lookupTableArray, ptcFitType=self.config.ptcFitType) | |||
dataset = self.fitPtcAndNonLinearity(dataset, lookupTableArray, ptcFitType=self.config.ptcFitType) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be helpful to clarify the comment before this line. Given the comment “Fit..., produce linearizer”, I would expect this to return something called linearizer
, not dataset
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have added a couple of extra comments in there.
4784315
to
5e3ce6a
Compare
Thank you for your comments. I have addressed them. |
No description provided.