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

validate_base API refinement

    XMLWordPrintable

    Details

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

      Description

      This ticket is to refine and improve the usability and documentation of validate_base, original ported in DM-7692.

      One goal is to improve API usability by better incorporating astropy units.

      Another goal is to validate_base to use PEP-style names (RFC-97).

      On the matter of RFC-97, which is still flagged, SQuaRE does have a waiver to use PEP8. As validate_base has not consumers (yet), is is appropriate to switch API naming at this time.

      In conjunction with this, the docs should be updated to use the new Sphinx templates and configuration (DM-7094), be updated with the new API names, and generally be polished.

        Attachments

          Issue Links

            Activity

            jsick Jonathan Sick created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Link DM-6196 [ 24712 ]
            jsick Jonathan Sick made changes -
            Link This issue is triggered by DM-6629 [ DM-6629 ]
            jsick Jonathan Sick made changes -
            Link This issue is triggered by RFC-97 [ RFC-97 ]
            jsick Jonathan Sick made changes -
            Link This issue is triggered by RFC-45 [ RFC-45 ]
            afausti Angelo Fausti made changes -
            Assignee Jonathan Sick [ jsick ] Angelo Fausti [ afausti ]
            jsick Jonathan Sick made changes -
            Epic Link DM-6196 [ 24712 ] DM-7573 [ 26751 ]
            jsick Jonathan Sick made changes -
            Assignee Angelo Fausti [ afausti ] Jonathan Sick [ jsick ]
            jsick Jonathan Sick made changes -
            Link This issue has to be done after DM-7692 [ DM-7692 ]
            jsick Jonathan Sick made changes -
            Summary Introduce PEP8 naming and new license style to validate_drp Introduce PEP8 naming validate_base
            jsick Jonathan Sick made changes -
            Description Change validate_drp to use new-style license information (RFC-45) and PEP-style names (RFC-97).

            On the matter of RFC-97, which is still flagged, SQuaRE does have a waiver to use PEP8, though validate_drp is also properly a part of the Stack. This will need to be clarified before work can begin.
            Change {{validate_base}} to use PEP-style names (RFC-97).

            On the matter of RFC-97, which is still flagged, SQuaRE does have a waiver to use PEP8. As {{validate_base}} has not consumers (yet), is is appropriate to switch API naming at this time.
            jsick Jonathan Sick made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            jsick Jonathan Sick made changes -
            Story Points 1
            jsick Jonathan Sick made changes -
            Story Points 1 1.4
            jsick Jonathan Sick made changes -
            Story Points 1.4 2.8
            jsick Jonathan Sick made changes -
            Story Points 2.8 4.6
            jsick Jonathan Sick made changes -
            Description Change {{validate_base}} to use PEP-style names (RFC-97).

            On the matter of RFC-97, which is still flagged, SQuaRE does have a waiver to use PEP8. As {{validate_base}} has not consumers (yet), is is appropriate to switch API naming at this time.
            Change {{validate_base}} to use PEP-style names (RFC-97).

            On the matter of RFC-97, which is still flagged, SQuaRE does have a waiver to use PEP8. As {{validate_base}} has not consumers (yet), is is appropriate to switch API naming at this time.

            In conjunction with this, the docs should be updated to use the new Sphinx templates and configuration (DM-7094), be updated with the new API names, and generally be polished.
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-7094 [ DM-7094 ]
            jsick Jonathan Sick made changes -
            Story Points 4.6 5.1
            jsick Jonathan Sick made changes -
            Story Points 5.1 5.8
            jsick Jonathan Sick made changes -
            Link This issue blocks DM-7933 [ DM-7933 ]
            jsick Jonathan Sick made changes -
            Link This issue has to be done before DM-7935 [ DM-7935 ]
            jsick Jonathan Sick made changes -
            Story Points 5.8 6.5
            jsick Jonathan Sick made changes -
            Story Points 6.5 8.6
            jsick Jonathan Sick made changes -
            Summary Introduce PEP8 naming validate_base validate_base API refinement
            jsick Jonathan Sick made changes -
            Description Change {{validate_base}} to use PEP-style names (RFC-97).

            On the matter of RFC-97, which is still flagged, SQuaRE does have a waiver to use PEP8. As {{validate_base}} has not consumers (yet), is is appropriate to switch API naming at this time.

            In conjunction with this, the docs should be updated to use the new Sphinx templates and configuration (DM-7094), be updated with the new API names, and generally be polished.
            This ticket is to refine and improve the usability and documentation of {{validate_base}}, original ported in DM-7692.

            One goal is to improve API usability by better incorporating astropy units.

            Another goal is to {{validate_base}} to use PEP-style names (RFC-97).

            On the matter of RFC-97, which is still flagged, SQuaRE does have a waiver to use PEP8. As {{validate_base}} has not consumers (yet), is is appropriate to switch API naming at this time.

            In conjunction with this, the docs should be updated to use the new Sphinx templates and configuration (DM-7094), be updated with the new API names, and generally be polished.
            jsick Jonathan Sick made changes -
            Story Points 8.6 9.3
            jsick Jonathan Sick made changes -
            Story Points 9.3 12.8
            jsick Jonathan Sick made changes -
            Story Points 12.8 13.5
            jsick Jonathan Sick made changes -
            Reviewers Simon Krughoff [ krughoff ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status In Review [ 10004 ] Done [ 10002 ]

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Reviewers:
              Simon Krughoff
              Watchers:
              Jonathan Sick, Simon Krughoff
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.