Skip to content

Commit 4cafa20

Browse files
authored
Use italics for emphasis (#2498)
1 parent 0b07f02 commit 4cafa20

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/documenting/standards.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ A few of the most common cases picked up in reviews are listed below:
1515
- 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".
1616
- 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.
1717
- 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).
18-
- 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".
18+
- 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".
1919
- Do not use ALL CAPITALS for emphasis - use _italics_ instead.
2020
- Use [sentence-style capitalization](https://learn.microsoft.com/en-us/style-guide/capitalization), also in headings.
2121
- Use **bold** to markup UI strings, for example:
2222
- Under **Settings**, select the three dots menu. Then, select **Restart Home Assistant** > **Quick reload**.
2323
- Don't use "e.g.". Instead, use _for example_, _such as_, or _like_.
24-
- All examples containing Jinja2 templates should be wrapped **outside** of the code markdown with the `{% raw %}` tag.
24+
- All examples containing Jinja2 templates should be wrapped _outside_ of the code markdown with the `{% raw %}` tag.
2525

2626
## Integration and platform pages
2727

0 commit comments

Comments
 (0)