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-30162: Add link to processing data tutorials #517

Merged
merged 1 commit into from Jun 4, 2021
Merged

Conversation

fred3m
Copy link
Contributor

@fred3m fred3m commented May 14, 2021

No description provided.

Copy link
Member

@jonathansick jonathansick left a comment

Choose a reason for hiding this comment

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

In addition to these changes, I also recommend taking this opportunity to add the deblending flag documentation page as mentioned in lsst/pipelines_lsst_io#176 (comment)

doc/lsst.pipe.tasks/index.rst Outdated Show resolved Hide resolved
Copy link
Member

@jonathansick jonathansick left a comment

Choose a reason for hiding this comment

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

This is a good start to bring the content over from the forum. The main things to update are:

  • Keep in mind that in reStructuredText, as opposed to Markdown, single backticks are used for links. Use double back ticks for code literals
  • We don't use formatting in headers
  • Use the second person for documentation ("you" not "we" or "a user").
  • I've provided the syntax to properly format the table in reStructuredText
  • We don't refer to EUPS package names in our user documentation; Instead refer to things Python APIs or task names.
  • The toctree in index.rst needs to be uncommented.

doc/lsst.pipe.tasks/deblending-flags-overview.rst Outdated Show resolved Hide resolved
doc/lsst.pipe.tasks/deblending-flags-overview.rst Outdated Show resolved Hide resolved
doc/lsst.pipe.tasks/deblending-flags-overview.rst Outdated Show resolved Hide resolved
doc/lsst.pipe.tasks/deblending-flags-overview.rst Outdated Show resolved Hide resolved
doc/lsst.pipe.tasks/deblending-flags-overview.rst Outdated Show resolved Hide resolved
doc/lsst.pipe.tasks/deblending-flags-overview.rst Outdated Show resolved Hide resolved
doc/lsst.pipe.tasks/deblending-flags-overview.rst Outdated Show resolved Hide resolved
doc/lsst.pipe.tasks/deblending-flags-overview.rst Outdated Show resolved Hide resolved
doc/lsst.pipe.tasks/index.rst Show resolved Hide resolved
doc/lsst.pipe.tasks/deblending-flags-overview.rst Outdated Show resolved Hide resolved
@fred3m fred3m merged commit 1e78989 into master Jun 4, 2021
@fred3m fred3m deleted the tickets/DM-30162 branch June 4, 2021 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants