📝 docs: align aggregation docstring enums with pinned live sets #166

Merged
mat merged 1 commit from docs/enum-align into main 2026-10-27 10:38:08 +00:00
Owner

Summary

 _aggregations.py docstrings
-  measure_kind:      "The kind of measure (default: FLOW)."            # ×3
+                      + pinned set: FLOW, QUANTITY, STATE, VALUE, INDEX, RATE
-  aggregation_type:   "None, SUM, MAX"                                 # ×2
-  aggregation_type:   "(default: MAX)"                                  # ×1
+                      + pinned set: NONE, MIN, MAX, SUM, AVERAGE        # ×3

Docstring enums now match the live-pinned parameter sweeps (2026-10-11, docs/energy.comwatt.com/aggregations.md §2.5). aggregationLevel was already aligned (WEEK rejected — a previous pass); timeAgoUnit keeps WEEK, which is valid there. aggregation_type was under-documented (missing MIN/AVERAGE), measure_kind undocumented.

Evidence

  • Before: docstrings listed a stale subset ("SUM", "MAX") or nothing.
  • After: every enum docstring carries its pinned live set and the rejection behavior; docstring-only — pytest = 216 passed, mypy clean.

Merge Danger

Door: two-way — documentation only.

Blast Radius: none — no code or behavior change.

## Summary ```diff _aggregations.py docstrings - measure_kind: "The kind of measure (default: FLOW)." # ×3 + + pinned set: FLOW, QUANTITY, STATE, VALUE, INDEX, RATE - aggregation_type: "None, SUM, MAX" # ×2 - aggregation_type: "(default: MAX)" # ×1 + + pinned set: NONE, MIN, MAX, SUM, AVERAGE # ×3 ``` Docstring enums now match the live-pinned parameter sweeps (2026-10-11, `docs/energy.comwatt.com/aggregations.md` §2.5). `aggregationLevel` was already aligned (WEEK rejected — a previous pass); `timeAgoUnit` keeps WEEK, which is valid there. `aggregation_type` was under-documented (missing MIN/AVERAGE), `measure_kind` undocumented. ## Evidence - **Before:** docstrings listed a stale subset ("SUM", "MAX") or nothing. - **After:** every enum docstring carries its pinned live set and the rejection behavior; docstring-only — `pytest` = 216 passed, `mypy` clean. ## Merge Danger **Door:** two-way — documentation only. **Blast Radius:** none — no code or behavior change.
📝 docs: align aggregation docstring enums with pinned live sets (#102)
All checks were successful
Tests / forgejo-pytest (pull_request) Successful in 43s
Tests / forgejo-pytest (push) Successful in 43s
1e58f8b171
mat changed title from WIP: 📝 docs: align aggregation docstring enums with pinned live sets to 📝 docs: align aggregation docstring enums with pinned live sets 2026-10-27 10:38:04 +00:00
mat merged commit 12ccf49af3 into main 2026-10-27 10:38:08 +00:00
mat deleted branch docs/enum-align 2026-10-27 10:38:08 +00:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
mat/python-comwatt-client!166
No description provided.