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

Cleanup deprecation timing specification in dev guide

    XMLWordPrintable

    Details

    • Story Points:
      0.25
    • Sprint:
      AP F19-6 (November)
    • Team:
      Alert Production

      Description

      The developer guide section about deprecating interfaces should be more explicit about the "when" aspect of things, per this Slack conversation:

      https://lsstc.slack.com/archives/C2JPL2DGD/p1575592222123300

      This ticket is to clear that up.

        Attachments

          Activity

          Hide
          Parejkoj John Parejko added a comment -

          Merlin Fisher-Levine: can you please review this small change to the dev guide, since you were the one who complained about it on slack? Please let me know if there's a way to word it that would make the intent clearer.

          As-built docs: https://developer.lsst.io/v/DM-22507/stack/deprecating-interfaces.html

          Show
          Parejkoj John Parejko added a comment - Merlin Fisher-Levine : can you please review this small change to the dev guide, since you were the one who complained about it on slack? Please let me know if there's a way to word it that would make the intent clearer. As-built docs: https://developer.lsst.io/v/DM-22507/stack/deprecating-interfaces.html
          Hide
          mfisherlevine Merlin Fisher-Levine added a comment -

          As Tim pointed out in a thread on Slack, "before" could mean "any time before" and "after" could mean any time after, so the only way not to be ambiguous is to say "in". However, I also think that people might, for some reason, not want to commit to removal in a specific version, so I don't really know what to do.

          To be clear, I never cared or found things ambiguous, I just had a reason to innocently check that a message meant exactly what it said, I never meant to make this level of trouble, so basically my review is "your changes look fine to me, but I also never thought there was a real problem, so do whatever you feel makes it most clear".

          Show
          mfisherlevine Merlin Fisher-Levine added a comment - As Tim pointed out in a thread on Slack, "before" could mean "any time before" and "after" could mean any time after, so the only way not to be ambiguous is to say "in". However, I also think that people might, for some reason, not want to commit to removal in a specific version, so I don't really know what to do. To be clear, I never cared or found things ambiguous, I just had a reason to innocently check that a message meant exactly what it said, I never meant to make this level of trouble, so basically my review is "your changes look fine to me, but I also never thought there was a real problem, so do whatever you feel makes it most clear".
          Hide
          tjenness Tim Jenness added a comment -

          I think we have converged on "after" because it gives us the flexibility to not quite be able to get around to removing something when the next release is being prepared.

          Show
          tjenness Tim Jenness added a comment - I think we have converged on "after" because it gives us the flexibility to not quite be able to get around to removing something when the next release is being prepared.
          Hide
          Parejkoj John Parejko added a comment -

          Thanks Merlin Fisher-Levine: I think it was useful to make the "why" messages more explicit in the examples anyway, so people have something to refer to when writing their own deprecation messages.

          Show
          Parejkoj John Parejko added a comment - Thanks Merlin Fisher-Levine : I think it was useful to make the "why" messages more explicit in the examples anyway, so people have something to refer to when writing their own deprecation messages.

            People

            Assignee:
            Parejkoj John Parejko
            Reporter:
            Parejkoj John Parejko
            Reviewers:
            Merlin Fisher-Levine
            Watchers:
            John Parejko, John Swinbank, Merlin Fisher-Levine, Tim Jenness
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.