From 75b93db64d063c6252ee98b981edef17617e246f Mon Sep 17 00:00:00 2001 From: RichardJJG Date: Fri, 20 Aug 2021 12:03:48 +0100 Subject: [PATCH 1/2] Added definition list formatting rule --- docs/help/contributor/style-guide/style-and-formatting.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/help/contributor/style-guide/style-and-formatting.md b/docs/help/contributor/style-guide/style-and-formatting.md index b6a80f19fd8..a8d92795e70 100644 --- a/docs/help/contributor/style-guide/style-and-formatting.md +++ b/docs/help/contributor/style-guide/style-and-formatting.md @@ -60,6 +60,10 @@ 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. + ## General style ### Use upper camel case for Knative API objects From 09f17507c816468449938ab0ad7cc96c9fff7f2d Mon Sep 17 00:00:00 2001 From: RichardJJG Date: Fri, 20 Aug 2021 14:02:42 +0100 Subject: [PATCH 2/2] Add example --- docs/help/contributor/style-guide/style-and-formatting.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/help/contributor/style-guide/style-and-formatting.md b/docs/help/contributor/style-guide/style-and-formatting.md index a8d92795e70..d89dfc798b2 100644 --- a/docs/help/contributor/style-guide/style-and-formatting.md +++ b/docs/help/contributor/style-guide/style-and-formatting.md @@ -64,6 +64,10 @@ between the number and the unit. 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