From 529ee4ee1bed2e5d698bdc87a2e050cb975ec5bf Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Sat, 11 Jun 2022 10:51:27 -1000 Subject: [PATCH] Fix typo in integration setup failures --- docs/integration_setup_failures.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/integration_setup_failures.md b/docs/integration_setup_failures.md index 785df0ac..5496cd3c 100644 --- a/docs/integration_setup_failures.md +++ b/docs/integration_setup_failures.md @@ -29,7 +29,7 @@ If your integration supports discovery, Home Assistant will automatically retry #### Handling logging of a retry Pass the error message to `ConfigEntryNotReady` as the first argument. Home Assistant will log the retry once with a log level of -`warning`, and subsequent retires are logged at `debug` level. The error message will also be propagated to the UI and shown on the integrations page. Suppose you do not set a message when raising `ConfigEntryNotReady`; in that case, Home Assistant will try to extract the reason from the exception that is the cause of `ConfigEntryNotReady` if it was propagated from another exception. +`warning`, and subsequent retries are logged at `debug` level. The error message will also be propagated to the UI and shown on the integrations page. Suppose you do not set a message when raising `ConfigEntryNotReady`; in that case, Home Assistant will try to extract the reason from the exception that is the cause of `ConfigEntryNotReady` if it was propagated from another exception. The integration should not log any non-debug messages about the retry, and should instead rely on the logic built-in to `ConfigEntryNotReady` to avoid spamming the logs. @@ -57,7 +57,7 @@ async def async_setup_platform( #### Handling logging of a retry Pass the error message to `PlatformNotReady` as the first argument. Home Assistant will log the retry once with a log level of -`warning`, and subsequent retires will be logged at `debug` level. Suppose you do not set a message when raising `ConfigEntryNotReady`; in that case, Home Assistant will try to extract the reason from the exception that is the cause of `ConfigEntryNotReady` if it was propagated from another exception. +`warning`, and subsequent retries will be logged at `debug` level. Suppose you do not set a message when raising `ConfigEntryNotReady`; in that case, Home Assistant will try to extract the reason from the exception that is the cause of `ConfigEntryNotReady` if it was propagated from another exception. The integration should not log any non-debug messages about the retry, and should instead rely on the logic built-in to `PlatformNotReady` to avoid spamming the logs.