Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-10984

Write "user guide" documentation for firefly_client

    XMLWordPrintable

    Details

    • Story Points:
      5
    • Epic Link:
    • Sprint:
      SUIT Sprint 2017-7, SUIT Sprint 2017-8, SUIT Sprint 2017-9, SUIT Sprint 2017-10, SUIT Sprint 2017-11, SUIT Sprint 2017-12, SUIT Sprint 2018-01
    • Team:
      Science User Interface

      Description

      In addition to the existing Python docstring documentation in firefly_client, it would be desirable to have "user guide"-type documentation, including examples, available.

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-9787 Publish Python API doc (firefly_client) and JSDoc to lsst.io

          • Done
          mentioned in

          Page Loading...

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            shupe David Shupe added a comment -

            Pull request is https://github.com/Caltech-IPAC/firefly_client/pull/14

            Work-In-Progress documentation at https://firefly-client.lsst.io/v/DM-10984-user-guide/index.html

            Show
            shupe David Shupe added a comment - Pull request is https://github.com/Caltech-IPAC/firefly_client/pull/14 Work-In-Progress documentation at https://firefly-client.lsst.io/v/DM-10984-user-guide/index.html
            Hide
            Permalink
            shupe David Shupe added a comment -

            Xiuqin Wu [X] passed along review comments by email

            Show
            shupe David Shupe added a comment - Xiuqin Wu [X] passed along review comments by email
            Hide
            Permalink
            shupe David Shupe added a comment -

            Merged

            Show
            shupe David Shupe added a comment - Merged

              People

              Assignee:
              shupe David Shupe
              Reporter:
              gpdf Gregory Dubois-Felsmann
              Reviewers:
              Gregory Dubois-Felsmann
              Watchers:
              David Shupe, Gregory Dubois-Felsmann, Xiuqin Wu [X] (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.