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

Include table persistence docs in Doxygen listing for afw

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: afw
    • Labels:
      None

      Description

      There's some documentation at https://github.com/lsst/afw/blob/1d3521f81d348fdc49b708342eba0be1caf5295b/doc/tablePersistence.dox which seems useful, but is basically impossible to find in Doxygen. Let's include it on the list at https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/afw.html.

        Attachments

          Activity

          Hide
          swinbank John Swinbank added a comment - - edited

          Jim Bosch — I found the material in this document useful the other day, so I'd like to expose it. The changes here are trivial, but it's not clear to me why it has been hidden away. Since you wrote it, I wanted to check with you for objections before proceeding.

          Show
          swinbank John Swinbank added a comment - - edited Jim Bosch — I found the material in this document useful the other day, so I'd like to expose it. The changes here are trivial, but it's not clear to me why it has been hidden away. Since you wrote it, I wanted to check with you for objections before proceeding.
          Hide
          jbosch Jim Bosch added a comment -

          Awesome, I totally forgot I had written that. This will make the next time I have to explain how table persistence works to someone much easier.

          Show
          jbosch Jim Bosch added a comment - Awesome, I totally forgot I had written that. This will make the next time I have to explain how table persistence works to someone much easier.
          Hide
          swinbank John Swinbank added a comment -

          Thanks — merged!

          Show
          swinbank John Swinbank added a comment - Thanks — merged!
          Hide
          krzys Krzysztof Findeisen added a comment -

          Wow, that was fast. For the record, the "basically impossible to find" documentation is in Related Pages. I actually had less trouble finding it than the afw page John Swinbank linked to, which isn't.

          Show
          krzys Krzysztof Findeisen added a comment - Wow, that was fast. For the record, the "basically impossible to find" documentation is in Related Pages. I actually had less trouble finding it than the afw page John Swinbank linked to, which isn't.
          Hide
          swinbank John Swinbank added a comment -

          Heh, navigating Doxygen is confusing. Krzysztof Findeisen is right that this is on the "related pages" tab even when you just hit the front page at https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/index.html. I had always assumed that was "material related to the content you're currently reading", but it doesn't seem to be.

          For what it's worth, I've added it to the afw "intro" page, which is what you get if you hit https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/index.html and then click on the link to afw.

          Anyway, the more places it's available the better, I guess.

          Show
          swinbank John Swinbank added a comment - Heh, navigating Doxygen is confusing. Krzysztof Findeisen is right that this is on the "related pages" tab even when you just hit the front page at https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/index.html . I had always assumed that was "material related to the content you're currently reading", but it doesn't seem to be. For what it's worth, I've added it to the afw "intro" page, which is what you get if you hit https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/index.html and then click on the link to afw. Anyway, the more places it's available the better, I guess.
          Hide
          krzys Krzysztof Findeisen added a comment - - edited

          That link should be read as "documentation that is related to the software, but is not API documentation". Which, in this context, means "related to the Stack". I guess most Doxygen sites are more at the level of a single package.

          Show
          krzys Krzysztof Findeisen added a comment - - edited That link should be read as "documentation that is related to the software, but is not API documentation". Which, in this context, means "related to the Stack". I guess most Doxygen sites are more at the level of a single package.

            People

            • Assignee:
              swinbank John Swinbank
              Reporter:
              swinbank John Swinbank
              Reviewers:
              Jim Bosch
              Watchers:
              Jim Bosch, John Swinbank, Krzysztof Findeisen
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel