DM-35721: Fix docs for image differencing tasks #231
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
The `backgroundModel` output was documented as a `Chebyshev1Function2D`, but it is produced by a subtask that only promises the less specific `Function2D`. There is no constraint in the config that enforces a Chebyshev model, either.
isullivan
approved these changes
Aug 26, 2022
Comment on lines
-270
to
+272
| selectSources : `lsst.afw.table.SourceCatalog`, optional | ||
| selectSources : `lsst.afw.table.SourceCatalog` | ||
| Identified sources on the science exposure. | ||
| idFactory : `lsst.afw.table.IdFactory` | ||
| idFactory : `lsst.afw.table.IdFactory`, optional |
There was a problem hiding this comment.
This documentation fix correctly matches the implementation, but that implementation is wrong. selectSources should be removed entirely, and idFactory should not have a default. Go ahead with these cleanups, and I will fix the code on DM-36043.
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 makes a few documentation fixes discovered while creating mock tasks for lsst/ap_verify#167.