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

Fix "Sigma" and "Err" in change controlled DM docs

    Details

      Description

      Find all uses of Err and Sigma in the version controlled DM documents (hopefully just LDMs?), determine if they are correct or not, and fix the ones that are incorrect.

      How many LDMs are there (of order 20 on the page below), and where do they all live? This document is a good start at finding them:

      https://confluence.lsstcorp.org/display/DM/Requirements+and+Design+Hierarchy

      This git repo should encompass all the important ones:

      https://github.com/lsst-dm/dm-docs.git

        Attachments

          Issue Links

            Activity

            Hide
            ktl Kian-Tat Lim added a comment -

            There are also DM-owned LSE documents (especially the DPDD, LSE-163) that may need to be updated as well.

            Show
            ktl Kian-Tat Lim added a comment - There are also DM-owned LSE documents (especially the DPDD, LSE-163) that may need to be updated as well.
            Hide
            Parejkoj John Parejko added a comment -

            John Swinbank: how should we manage this ticket? Whose responsibility is it?

            Show
            Parejkoj John Parejko added a comment - John Swinbank : how should we manage this ticket? Whose responsibility is it?
            Hide
            tjenness Tim Jenness added a comment -

            A quick look at the dm-docs repo suggests DPDD is the only document using Err/Sigma so if DPDD is correct then there is nothing to do.

            Show
            tjenness Tim Jenness added a comment - A quick look at the dm-docs repo suggests DPDD is the only document using Err/Sigma so if DPDD is correct then there is nothing to do.
            Hide
            swinbank John Swinbank added a comment -

            LDM-153 wants updating, at least if the comments on DM-10935 are to be believed. Fritz Mueller &/or Colin Slater should likely take the lead on that.

            Show
            swinbank John Swinbank added a comment - LDM-153 wants updating, at least if the comments on DM-10935 are to be believed. Fritz Mueller &/or Colin Slater should likely take the lead on that.
            Hide
            ctslater Colin Slater added a comment -

            LDM-153 needs to get a bulk update from cat in general, so I see no need to address it specifically on this ticket. (But cat should get updated, I assume on DM-10935

            Show
            ctslater Colin Slater added a comment - LDM-153 needs to get a bulk update from cat in general, so I see no need to address it specifically on this ticket. (But  cat should get updated, I assume on DM-10935 ) 
            Hide
            swinbank John Swinbank added a comment -

            In an effort to bring this to a conclusion, I suggest:

            • I understand the scope of this ticket only to be in reference to the literals Sigma and Err in naming quantities in DM documentation. It does not cover e.g. the use of “sigma” in narrative text or the symbol \sigma.
            • We exclude LDM-153 from this ticket, and assume it is handled on DM-10935.
            • We agree that any attempt to comprehensively update all change-controlled documentation is too large a time investment at this stage: some change-controlled documents are just note worth the effort (e.g. LDM-227).

            Given those caveats, a quick search of (the master versions of) LDM and LSE documents included in the dm-docs repository indicates that the following documents are affected:

            • LSE-163 (I assume this is correct, since it originates the convention)
            • LDM-639 (Uses the terms only when quoting pipeline output; I propose that this usage does not need changing)
            • LDM-533 (as per LDM-639)
            • LDM-17 (A report on a 2009-era data challenge which refers to getXErr(); I propose to ignore this)

            I propose, therefore that there is no further work to be done on this ticket, and we should simply close it. Objections?

            Show
            swinbank John Swinbank added a comment - In an effort to bring this to a conclusion, I suggest: I understand the scope of this ticket only to be in reference to the literals Sigma and Err in naming quantities in DM documentation. It does not cover e.g. the use of “sigma” in narrative text or the symbol \sigma . We exclude LDM-153 from this ticket, and assume it is handled on DM-10935 . We agree that any attempt to comprehensively update all change-controlled documentation is too large a time investment at this stage: some change-controlled documents are just note worth the effort (e.g. LDM-227). Given those caveats, a quick search of (the master versions of) LDM and LSE documents included in the dm-docs repository indicates that the following documents are affected: LSE-163 (I assume this is correct, since it originates the convention) LDM-639 (Uses the terms only when quoting pipeline output; I propose that this usage does not need changing) LDM-533 (as per LDM-639) LDM-17 (A report on a 2009-era data challenge which refers to getXErr() ; I propose to ignore this) I propose, therefore that there is no further work to be done on this ticket, and we should simply close it. Objections?
            Hide
            Parejkoj John Parejko added a comment -

            I'm fine with all of your points above.

            Show
            Parejkoj John Parejko added a comment - I'm fine with all of your points above.
            Hide
            swinbank John Swinbank added a comment -

            Given the lack of complaints, I'll shut this one down. Thanks all.

            Show
            swinbank John Swinbank added a comment - Given the lack of complaints, I'll shut this one down. Thanks all.

              People

              • Assignee:
                swinbank John Swinbank
                Reporter:
                Parejkoj John Parejko
                Watchers:
                Colin Slater, John Parejko, John Swinbank, Jonathan Sick, Kian-Tat Lim, Leanne Guy, Simon Krughoff, Tim Jenness
              • Votes:
                0 Vote for this issue
                Watchers:
                8 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel