Skip to content

Commit 60a0677

Browse files
martinbonninbenjie
andauthored
Add definitions to the style guide (#1137)
Co-authored-by: Benjie <benjie@jemjie.com>
1 parent a1c025f commit 60a0677

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

STYLE_GUIDE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,12 @@ MyAlgorithm(argOne, argTwo):
8282
- Let {something} be {true}.
8383
- Return {something}.
8484
```
85+
86+
## Definitions
87+
88+
For important terms, use
89+
[Spec Markdown definition paragraphs](https://spec-md.com/#sec-Definition-Paragraph).
90+
91+
Definition paragraphs start with `::` and add the matching italicized term to
92+
the [specification index](https://spec.graphql.org/draft/#index), making it easy
93+
to reference them.

0 commit comments

Comments
 (0)