Skip to content

Conversation

arunkannawadi
Copy link
Member

No description provided.

@arunkannawadi arunkannawadi force-pushed the u/kannawad-documenting-new-package branch from d02365a to 3df6bda Compare July 23, 2021 00:44
Copy link
Contributor

@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.

Thanks, this is a good idea to cross-reference here.

These steps are already documented in https://developer.lsst.io/stack/add-a-package-to-pipelines-lsst-io.html, though, so we'd rather not duplicate details about the pipelines_lsst_io table file across two pages. Could you please re-write the paragraph so that it links to that page to avoid duplication of content? I've included suggested content.

Table files should use ``setupRequired(package_name)`` or ``setupOptional(package_name)`` as necessary; test data packages are usually optional to allow releases to be made without requiring large additional data packages to be included.
Packages that use optional dependencies must be written to ensure that they can pass their unit tests when the package is not available.

The new package may be added to the :file:`ups/pipelines_lsst_io.table` file in `lsst/pipelines_lsst_io`_ repository so that its documentation is built as HTML pages and made available at https://pipelines.lsst.io/v/daily.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The new package may be added to the :file:`ups/pipelines_lsst_io.table` file in `lsst/pipelines_lsst_io`_ repository so that its documentation is built as HTML pages and made available at https://pipelines.lsst.io/v/daily.
Finally, if the package is part of the LSST Science Pipelines, you should include it in the Pipelines documentation, https://pipelines.lsst.io.
See :doc:`/stack/add-a-package-to-pipelines-lsst-io` for instructions.

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.

2 participants