Skip to content

Commit

Permalink
Add definitions to the style guide (#1137)
Browse files Browse the repository at this point in the history
Co-authored-by: Benjie <[email protected]>
  • Loading branch information
martinbonnin and benjie authored Feb 26, 2025
1 parent a1c025f commit 60a0677
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,12 @@ MyAlgorithm(argOne, argTwo):
- Let {something} be {true}.
- Return {something}.
```

## Definitions

For important terms, use
[Spec Markdown definition paragraphs](https://spec-md.com/#sec-Definition-Paragraph).

Definition paragraphs start with `::` and add the matching italicized term to
the [specification index](https://spec.graphql.org/draft/#index), making it easy
to reference them.

0 comments on commit 60a0677

Please sign in to comment.