1
0
mirror of synced 2025-12-19 18:10:59 -05:00

add parenthetical dashes (#56224)

Co-authored-by: hubwriter <hubwriter@github.com>
This commit is contained in:
Thom Wong
2025-07-03 11:08:58 +02:00
committed by GitHub
parent cdfadb43fd
commit 83ab1172fe

View File

@@ -810,6 +810,19 @@ If multiple roles or products apply to a permission statement or product callout
You can use inline links to provide more information about a role or product. The linked text must match the link destination so that it is clear where following the link will lead to.
## Parenthetical dashes
We use em dashes for parenthetical statements in normal body text. This doesnt apply to text within code blocks.
Examples:
* ✅ Correct: "The cat—which sat on a branch—smiled with a broad grin." (em dash without spaces)
* ❌ Incorrect: "The cat — which sat on a branch — smiled with a broad grin." (em dash with spaces)
* ❌ Incorrect: "The catwhich sat on a branchsmiled with a broad grin." (en dash without spaces)
* ❌ Incorrect: "The cat which sat on a branch smiled with a broad grin." (en dash with spaces)
* ❌ Incorrect: "The cat-which sat on a branch-smiled with a broad grin." (hyphen without spaces)
* ❌ Incorrect: "The cat - which sat on a branch - smiled with a broad grin." (hyphen with spaces)
## Placeholders
Style any placeholder text in all caps. If a placeholder is multiple words, connect the words with dashes (kebab-case). If you use a placeholder, explain what someone might replace it with. This helps people modify examples to fit their needs and helps identify placeholders for people who use assistive technology.