Skip to content
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.

Sign up for GitHub

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

Jump to bottom

DM-37801: Move diffim and meas_algorithms task docs from python files to ReST #250

Merged
merged 3 commits into from Apr 21, 2023
Merged

DM-37801: Move diffim and meas_algorithms task docs from python files to ReST #250

merged 3 commits into from Apr 21, 2023

Conversation

bsmartradio
Copy link
Contributor

Create ReST files for the following tasks and move existing documentation into the document files.

ModelPsfMatchTask
DecorrelateALKernelTask
DecorrelateALKernelSpatialTask
DiaCatalogSourceSelectorTask
DipoleMeasurementTask
GetCoaddAsTemplateTask
ImagePsfMatchTask

parejkoj
parejkoj requested changes Mar 2, 2023
View reviewed changes
Copy link
Contributor

@parejkoj parejkoj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this, and sorry it took so long for me to get to it.

Pushing one set of comments now; I'm in the process of reworking some of this, which will rename many files, so please wait before making other changes.

doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DecorrelateALKernalSpatialTask.rst Outdated Show resolved Hide resolved
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DecorrelateALKernalSpatialTask.rst Outdated Show resolved Hide resolved
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DecorrelateALKernelTask.rst Outdated Show resolved Hide resolved
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DiaCatalogSourceSelectorTask.rst Outdated Show resolved Hide resolved
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DipoleMeasurementTask.rst Outdated Show resolved Hide resolved
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DipoleMeasurementTask.rst Outdated Show resolved Hide resolved
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DipoleMeasurementTask.rst Outdated Show resolved Hide resolved
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DipoleMeasurementTask.rst Outdated Show resolved Hide resolved
parejkoj
parejkoj requested changes Mar 2, 2023
View reviewed changes
Copy link
Contributor

@parejkoj parejkoj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, and please rebase->edit your commit with all of the squashed commits in it. The multiple lines there aren't helpful, since it's now one coherent commit.

@bsmartradio bsmartradio force-pushed the tickets/DM-37801 branch 2 times, most recently from 7de97f7 to cd2aec5 Compare March 6, 2023 19:20
parejkoj
parejkoj approved these changes Apr 20, 2023
View reviewed changes
Copy link
Contributor

@parejkoj parejkoj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to git rebase origin main, but otherwise this should be good to go.

bsmartradio and others added 3 commits April 21, 2023 12:18
@bsmartradio
Move docs to separate RST files
00b304d 
Move documentation out of .py files into docs folder

Moved task documentation out of the notes section of the doc strings in the respective .py files and into separate .rst files.
Update formatting
@parejkoj @bsmartradio
Cleanup new RST docs and add auto-build sections
54fc30d
@bsmartradio
Update formatting and RST links
7968501
@bsmartradio bsmartradio merged commit 85b7a35 into main Apr 21, 2023
1 check passed
@bsmartradio bsmartradio deleted the tickets/DM-37801 branch April 21, 2023 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@parejkoj parejkoj parejkoj approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@bsmartradio @parejkoj