mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-13 20:36:29 +00:00
Merge pull request #1363 from home-assistant/bdraco-patch-1
Fix typo in integration setup failures
This commit is contained in:
commit
3a1d9a55a0
@ -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.
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user