Skip to content

Documentation and hinting

Danny Love requested to merge documentation_and_hinting into main

Description

Wrote a few missing docstrings, and ran autoformatting on a few files.

Related Issue(s)

Changes Made

  • Change 1: Added some missing docstrings to test files & one function in edit_records.py (we now have 100% docstring coverage, yay)
  • Change 2: Added periods to a few docstring descriptions (pre-commit requires this for files in src, but doesn't check tests).
  • Change 3: Updated a docstring in login.py to reflect the change to how we're storing user type
  • Change 4: Added docstring to setup.py
  • Change 5: Fixed one try/except block with multiple error types on a single line (not allowed).
  • Change 6: Lots of auto-formatting / line length stuff.
  • Change 7: Added type hinting to fixtures, just for fun.

Test Plan

  • make test

Checklist

  • Code follows the project's coding style and conventions.
  • Automated tests for the changes have been added or existing tests have been updated.
  • Code coverage for new or modified code is maintained or improved.
  • The code builds and runs without errors or warnings.
  • Documentation has been updated to reflect the changes made.
  • All discussions and feedback on the PR have been addressed.
  • CI/CD pipelines pass successfully, including any required checks or tests.
  • The PR has been reviewed and approved by the designated reviewers.
Edited by Danny Love

Merge request reports

Loading