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

Add Click documentation to the developer guide

    XMLWordPrintable

    Details

    • Story Points:
      4
    • Sprint:
      DB_F20_09
    • Team:
      Data Access and Database
    • Urgent?:
      No

      Attachments

        Issue Links

          Activity

          Hide
          tjenness Tim Jenness added a comment -

          I had forgotten about this ticket since it wasn't tagged with daf_butler. The documentation in daf_butler looks like a very good start. Did we decide on some words for the developer guide itself?

          Show
          tjenness Tim Jenness added a comment - I had forgotten about this ticket since it wasn't tagged with daf_butler. The documentation in daf_butler looks like a very good start. Did we decide on some words for the developer guide itself?
          Hide
          npease Nate Pease [X] (Inactive) added a comment -

          I had work on the developer guide going, in DM-24329, which I seem to have closed incorrectly but have now reopened.

          I stalled on documentation partly because we were learning and deciding how we were using Click for our case, and I didn't know how to write about it yet and/or it was changing too fast. I think things are becoming more solid now, and it's probably time to get back to these two tickets.

          Show
          npease Nate Pease [X] (Inactive) added a comment - I had work on the developer guide going, in  DM-24329 , which I seem to have closed incorrectly but have now reopened. I stalled on documentation partly because we were learning and deciding how we were using Click for our case, and I didn't know how to write about it yet and/or it was changing too fast. I think things are becoming more solid now, and it's probably time to get back to these two tickets.
          Hide
          npease Nate Pease [X] (Inactive) added a comment -

          Ignore the daf_butler branch; it will not get checked in with this ticket. 

          Show
          npease Nate Pease [X] (Inactive) added a comment - Ignore the daf_butler branch; it will not get checked in with this ticket. 
          Hide
          npease Nate Pease [X] (Inactive) added a comment -

          John Swinbank thanks for offering to review!

          Show
          npease Nate Pease [X] (Inactive) added a comment - John Swinbank thanks for offering to review!
          Hide
          swinbank John Swinbank added a comment -

          Thanks for adding documentation, Nate Pease [X]! I left a few comments on the dm_dev_guide PR; in general, this material is great, but there are a couple of suggestions there for sharpening it up a bit.

          Show
          swinbank John Swinbank added a comment - Thanks for adding documentation, Nate Pease [X] ! I left a few comments on the dm_dev_guide PR; in general, this material is great, but there are a couple of suggestions there for sharpening it up a bit.
          Hide
          npease Nate Pease [X] (Inactive) added a comment -

          John Swinbank thanks for the suggestions. I've uploaded new changes to the PR. It removes the unnecessary example code and attempts to just say what to do, including the additional info you asked for. Please have a look.

          Show
          npease Nate Pease [X] (Inactive) added a comment - John Swinbank thanks for the suggestions. I've uploaded new changes to the PR. It removes the unnecessary example code and attempts to just say what to do, including the additional info you asked for. Please have a look.
          Hide
          swinbank John Swinbank added a comment -

          Sorry Nate; I dropped the ball on this. I've just taken a look, and your reworked documentation looks great. Thank you!

          Show
          swinbank John Swinbank added a comment - Sorry Nate; I dropped the ball on this. I've just taken a look, and your reworked documentation looks great. Thank you!

            People

            Assignee:
            npease Nate Pease [X] (Inactive)
            Reporter:
            npease Nate Pease [X] (Inactive)
            Reviewers:
            John Swinbank
            Watchers:
            John Swinbank, Kian-Tat Lim, Nate Pease [X] (Inactive), Tim Jenness
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.