Skip to content

docs: add model docstrings and inline pricing metadata mixin#956

Merged
vdusek merged 1 commit into
masterfrom
docs/model-docstrings
Jun 9, 2026
Merged

docs: add model docstrings and inline pricing metadata mixin#956
vdusek merged 1 commit into
masterfrom
docs/model-docstrings

Conversation

@vdusek

@vdusek vdusek commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Split out from #950 (the other half is the to_camel alias refactor).

Adds concise class and field docstrings to all @docs_group-decorated models that were missing them:

  • events/_types.pySystemInfoEventData (8 resource-usage metric fields) and the 8 event wrappers (name / data).
  • _charging.py — the pricing-info models, plus module-level constant docstrings and a few inline comments converted to docstrings.

Also inlines the private _RelaxedPricingMetadata mixin into the four pricing subclasses so each documents its own relaxed fields. This is behavior-preserving (field order, aliases, and requiredness are unchanged).

This PR keeps the manual field aliases and branches from master independently of #950. Once #950 merges, this branch will need a rebase to resolve the overlapping changes in _charging.py / events/_types.py.

@github-actions github-actions Bot added this to the 142nd sprint - Tooling team milestone Jun 9, 2026
@github-actions github-actions Bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Jun 9, 2026
@codecov

codecov Bot commented Jun 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.64%. Comparing base (10203bc) to head (ed80953).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #956      +/-   ##
==========================================
+ Coverage   86.38%   86.64%   +0.26%     
==========================================
  Files          48       48              
  Lines        2916     2966      +50     
==========================================
+ Hits         2519     2570      +51     
+ Misses        397      396       -1     
Flag Coverage Δ
e2e ?
integration 58.56% <100.00%> (+0.74%) ⬆️
unit 74.98% <100.00%> (+0.42%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@vdusek vdusek requested a review from Pijukatel June 9, 2026 12:09
@vdusek vdusek added the adhoc Ad-hoc unplanned task added during the sprint. label Jun 9, 2026
@vdusek vdusek merged commit 7c9f2b1 into master Jun 9, 2026
26 of 29 checks passed
@vdusek vdusek deleted the docs/model-docstrings branch June 9, 2026 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants