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-13756 write descriptions for datasets #91

Merged
merged 2 commits into from Apr 29, 2018
Merged

Conversation

parejkoj
Copy link
Collaborator

No description provided.

Copy link
Member

@timj timj left a comment

Choose a reason for hiding this comment

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

Looks fine in general. I'd prefer shorter lines with more line breaks.

@@ -99,6 +100,7 @@ deepCoadd_ref_schema:
python: lsst.afw.table.SourceCatalog
template: schema/deepCoadd_ref.fits
deepCoaddId:
description: "A unique identifier for a coadd of a single patch. This is overridden by the CameraMapper and not a persisted dataset."
Copy link
Member

Choose a reason for hiding this comment

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

Can you line break this please? It's easier to read if the lines are shorter (especially on GitHub)

@@ -179,6 +191,7 @@ transformed_src_schema:
python: lsst.afw.table.BaseCatalog
template: schema/transformed_src.fits
deepMergedCoaddId:
description: "A unique identifier for a band-merged catalog of a single patch. This is overridden by the CameraMapper and not a persisted dataset."
Copy link
Member

Choose a reason for hiding this comment

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

Line break please.

@parejkoj
Copy link
Collaborator Author

I reflowed some lines (all the ones with a sentence break, and a few others). We'd been roughly following the "line breaks at sentence boundaries" guidelines for RST and other docs. I'm not sure how much that matters in this case. Let me know if you want me to trim some more.

@parejkoj parejkoj merged commit 4306411 into master Apr 29, 2018
@ktlim ktlim deleted the tickets/DM-13756 branch August 25, 2018 06:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants