jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-14 12:56:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix typo in integration setup failures

Browse Source
This commit is contained in:
J. Nick Koston 2022-06-11 10:51:27 -10:00 committed by GitHub
parent 754e39130d
commit 529ee4ee1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/integration_setup_failures.md
View File

@ -29,7 +29,7 @@ If your integration supports discovery, Home Assistant will automatically retry
#### Handling logging of a 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 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. 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 #### 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 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. 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.