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.

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-27086: Numpydoc conversion of meas_algorithms through gaussianPsfFactory.py #214

Merged
merged 1 commit into from Nov 13, 2020

Conversation

squisty
Copy link
Contributor

@squisty squisty commented Oct 22, 2020

No description provided.

@squisty squisty changed the title Numpydoc conversion of meas_algorithms through gaussianPsfFactory.py DM-27086: Numpydoc conversion of meas_algorithms through gaussianPsfFactory.py Oct 27, 2020
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: a few comments, including correcting a non-building numbered list.

``DynamicDetectionTask`` runs this sequence of operations:

#. Detects sources using a lower threshold than normal in order
to identify good sky regions.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please try to keep sentences together on one line (here and below): it makes the diffs a bit clearer. There is no "80 character" limit for restructured text.

https://developer.lsst.io/restructuredtext/style.html#text-wrapping

It doesn't look like this is auto-listing in the built docs because of the newline as well.

I think the numbered list needs to not have spaces between the items, but I'm not positive of that.

https://developer.lsst.io/restructuredtext/style.html#lists

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed the sentence issue, the template for the task topic mentioned on https://developer.lsst.io/stack/task-topic-type.html#starter-template has blank lines in between so I will go off of that for now?

Copy link
Contributor

Choose a reason for hiding this comment

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

The numbered list generated correctly now.

python/lsst/meas/algorithms/gaussianPsfFactory.py Outdated Show resolved Hide resolved
@squisty squisty merged commit 29f4168 into master Nov 13, 2020
@squisty squisty deleted the tickets/DM-27086 branch November 13, 2020 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants