From 02c2778b8d77a5b9f5877db05395a2159cf13f4a Mon Sep 17 00:00:00 2001 From: Paul Kompfner Date: Tue, 17 Feb 2026 11:07:27 -0500 Subject: [PATCH] Document `_warn_unhandled_updated_settings` pattern in COMMUNITY_INTEGRATIONS.md. --- COMMUNITY_INTEGRATIONS.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/COMMUNITY_INTEGRATIONS.md b/COMMUNITY_INTEGRATIONS.md index c169cb5ab..a7cfa6103 100644 --- a/COMMUNITY_INTEGRATIONS.md +++ b/COMMUNITY_INTEGRATIONS.md @@ -282,7 +282,22 @@ async def _update_settings(self, update: STTSettings) -> set[str]: return changed ``` -Note that, in this example, the service requires a reconnect to apply the new language. Consider whether your service requires reconnection or can apply changes in-place. +Note that, in this example, the service requires a reconnect to apply the new language. Consider, for each setting, whether your service requires reconnection or can apply changes in-place. + +If your service can't yet apply certain settings at runtime, call `self._warn_unhandled_updated_settings(changed)` with the set of unhandled field names so users get a clear log message: + +```python +async def _update_settings(self, update: STTSettings) -> set[str]: + changed = await super()._update_settings(update) + + if not changed: + return changed + + # TODO: someday we could reconnect here to apply updated settings. + self._warn_unhandled_updated_settings(changed) + + return changed +``` ### Sample Rate Handling