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

          Container Issues

            Issue Links

            blocks

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-7933 Port validate_drp to validate_base framework

            • Done
            has to be done after

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-7692 Create validate_base package

            • Done
            has to be done before

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-7935 Validate metric.yaml schemas for validate_base packages

            • To Do
            is triggered by

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-6629 validate_drp: design and implement an API for metric measurements and serializations

            • Done

            RFC - An issue whose primary purpose is to advertise an intent and allow stakeholders to comment. RFC-45 Process for maintaining Copyright information in DM source code

            • Implemented

            RFC - An issue whose primary purpose is to advertise an intent and allow stakeholders to comment. RFC-97 Allow PEP8 naming conventions in python style guide

            • Implemented
            relates to

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-7094 Develop Sphinx configuration for Pipelines Documentation, including MVP HTML/CSS Template

            • Done

              Activity

                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:

                    Summary Panel