Skip to content

Add docstrings and annotations to models#215

Merged
OCopping merged 2 commits intomainfrom
improve-models
May 6, 2026
Merged

Add docstrings and annotations to models#215
OCopping merged 2 commits intomainfrom
improve-models

Conversation

@OCopping
Copy link
Copy Markdown
Collaborator

@OCopping OCopping commented May 5, 2026

This adds simple docstrings to each model, as well as field annotations to every attribute of the individual models. Hopefully this will help future developers to understand them better.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.66%. Comparing base (28f53e3) to head (e688293).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #215   +/-   ##
=======================================
  Coverage   94.66%   94.66%           
=======================================
  Files          10       10           
  Lines         825      825           
=======================================
  Hits          781      781           
  Misses         44       44           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@OCopping OCopping merged commit 663300c into main May 6, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants