docs: add model docstrings and inline pricing metadata mixin#956
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Pijukatel
approved these changes
Jun 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Split out from #950 (the other half is the
to_camelalias refactor).Adds concise class and field docstrings to all
@docs_group-decorated models that were missing them:events/_types.py—SystemInfoEventData(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
_RelaxedPricingMetadatamixin 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
masterindependently of #950. Once #950 merges, this branch will need a rebase to resolve the overlapping changes in_charging.py/events/_types.py.