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-22 08:46:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add description of issue severities (#1886)

Browse Source 
* Add description of issue severities

* Apply suggestions from code review

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

---------

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Jan-Philipp Benecke 2023-08-24 09:50:05 +02:00 committed by GitHub
parent dc86fc0bdf
commit 59be20342a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/core/platform/repairs.md
View File

@ -34,6 +34,16 @@ ir.async_create_issue(
| translation_key | str | | Translation key with a brief explanation of the issue
| translation_placeholders | dict | `None` | Placeholders which will be injected in the translation
### Severity of an issue
To better understand which severity level to choose, see the list below.
| IssueSeverity | Description |
|---------------|--------------------------------------------------------------------|
| CRITICAL | Considered reserved, only used for true panic |
| ERROR | Something is currently broken and needs immediate attention |
| WARNING | Something breaks in the future (e.g., API shutdown) and needs attention |
## Offering a repair
Create a new platform file in your integration folder called `repairs.py` and add code according to the pattern below.