From 4cafa2053ddd7c0b93f8c19bc95692612dbf477c Mon Sep 17 00:00:00 2001 From: William Poetra Yoga Date: Tue, 17 Dec 2024 03:48:37 +0700 Subject: [PATCH] Use italics for emphasis (#2498) --- docs/documenting/standards.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/documenting/standards.md b/docs/documenting/standards.md index 13e39065..19396d4a 100644 --- a/docs/documenting/standards.md +++ b/docs/documenting/standards.md @@ -15,13 +15,13 @@ A few of the most common cases picked up in reviews are listed below: - Use a serial comma (also known as the Oxford comma) before the conjunction in a list of three or more items. For example, "Through the use of additional adapters, Home Assistant allows the use of Zigbee, Z-Wave, and other protocols". - There is no limit for the line length. You are allowed to write in a flowing text style. This will make it easier to use the GitHub online editor in the future. - Be objective and not gender favoring, polarizing, race related or religion inconsiderate. Contributions which do not follow this may be in breach of our [Code of Conduct](https://github.com/home-assistant/core/blob/master/CODE_OF_CONDUCT.md). -- The case of brand names, services, protocols, integrations and platforms must match its respective counterpart. For example, "Z-Wave" **not** "Zwave", "Z-wave", "Z Wave" or "ZWave". Also, "Input Select" **not** "input select" or "Input select". +- The case of brand names, services, protocols, integrations and platforms must match its respective counterpart. For example, "Z-Wave" _not_ "Zwave", "Z-wave", "Z Wave" or "ZWave". Also, "Input Select" _not_ "input select" or "Input select". - Do not use ALL CAPITALS for emphasis - use _italics_ instead. - Use [sentence-style capitalization](https://learn.microsoft.com/en-us/style-guide/capitalization), also in headings. - Use **bold** to markup UI strings, for example: - Under **Settings**, select the three dots menu. Then, select **Restart Home Assistant** > **Quick reload**. - Don't use "e.g.". Instead, use _for example_, _such as_, or _like_. -- All examples containing Jinja2 templates should be wrapped **outside** of the code markdown with the `{% raw %}` tag. +- All examples containing Jinja2 templates should be wrapped _outside_ of the code markdown with the `{% raw %}` tag. ## Integration and platform pages