diff --git a/docs/help/contributor/style-guide/style-and-formatting.md b/docs/help/contributor/style-guide/style-and-formatting.md index b6a80f19fd8..d89dfc798b2 100644 --- a/docs/help/contributor/style-guide/style-and-formatting.md +++ b/docs/help/contributor/style-guide/style-and-formatting.md @@ -60,6 +60,14 @@ between the number and the unit. |Click **Fork** | Click "Fork" |Select **Other** | Select "Other" +### Use tables for definition lists + +When listing terms and their definitions, use table formatting instead of definition list formatting. + +|:white_check_mark: Correct |:no_entry: Incorrect +|--------------------|----- +|`|Value |Description |`
`|------|---------------------|`
`|Value1|Description of Value1|`
`|Value2|Description of Value2|`|`Value1`
`: Description of Value1`

`Value2`
`: Description of Value2`| + ## General style ### Use upper camel case for Knative API objects