Correct stale settings-count and API clock docstrings
The household-timezone change added an eleventh setting (timezone) and made the API's household-local dates derive from it. Update the admin routes' settings, missed-sweep and occurrence-preview docstrings and core/sweep.py's docstrings to say so (empty timezone falls back to host local). Documentation only; no behaviour change. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -40,8 +40,8 @@ announces nothing.
|
||||
|
||||
The caller supplies ``today`` as a plain :class:`datetime.date`: the
|
||||
household-local calendar date, read from ``hass.config.time_zone`` by
|
||||
the integration or from the API host's local clock by the API. This
|
||||
module never reads a timezone database or config of its own.
|
||||
the integration or from the configured household timezone by the API.
|
||||
This module never reads a timezone database or config of its own.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
@@ -98,7 +98,8 @@ async def run_missed_sweep(
|
||||
|
||||
``today`` is the household-local calendar date the sweep runs for
|
||||
(the caller owns the clock: the integration reads it from
|
||||
``hass.config.time_zone``, the API from its host's local time).
|
||||
``hass.config.time_zone``, the API from the configured household
|
||||
timezone, falling back to its host's local time when unset).
|
||||
Returns the ``(event_type, payload)`` tuples to announce, EMPTY
|
||||
when the watermark already covers ``today`` (a same-night rerun) —
|
||||
the caller decides how to publish them and announces nothing on
|
||||
|
||||
Reference in New Issue
Block a user