DM-13941 Update doc/ directory for sphinx #12
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
jonathansick
approved these changes
Apr 4, 2018
There was a problem hiding this comment.
Thanks @parejkoj! Just a couple comments on the Numpydoc, but otherwise good to go.
| Returns | ||
| ------- | ||
| overlapBBox : `lsst.afw.geom.Box2I` | ||
| region of overlap between exposure and coadd in parent coordinates |
There was a problem hiding this comment.
Capitalize Region, and put a full-stop at the end of the sentence.
I think put exposure in double back ticks since it refers to the parameter.
| - background-subtracted or background-matched to the other images being coadded | ||
| - psf-matched to the desired PSF model (optional) | ||
| - warped to match the coadd | ||
| @param[in] weightFactor: weight with which to add exposure to coadd | ||
| weightFactor : `float` | ||
| weight with which to add exposure to coadd |
There was a problem hiding this comment.
Capitalize Weight, and put a full-stop at the end of the sentence.
exposure in double back ticks.
| Mask planes to pay attention to when rejecting masked pixels. | ||
| Specify as a collection of names. | ||
| badMaskPlanes should always include "EDGE". | ||
| logName : `str` |
| overlapBBox : `lsst.afw.geom.Box2I` | ||
| region of overlap between exposure and coadd in parent coordinates | ||
| weight : `float` | ||
| weight with which exposure was added to coadd; |
There was a problem hiding this comment.
Sentence-ify (capitalization and full stop).
parejkoj
force-pushed
the
tickets/DM-13941
branch
from
63ad1e7
to
cc502d3
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.