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

validate_base API refinement

    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

              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