diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 751841c..e067cfe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,6 +53,13 @@ All codes must be formatted properly, we use `goimports` which wrappes around and `make fmt` to format your code. Make sure your code doesn't have issues with `make checkfmt` and `make lint` before submission. +Formatter tests are separated into different groups in order to be able to improve +and maintain the code coverage and also prevent duplicating and running redundant +test cases. For example there are `OnlyXXX` tests which makes sure all sections are +hidden and only one is visible. This removes the need to test for `NotXXX` (which is +no deprecated and removed). Please make sure when a new feature is added or an issue +is fixed the corresponding `.golden` files and test cases are also update accordingly. + Once your change is written, tested, and documented the final step is to have it reviewed! You'll be presented with a template and a small checklist when you open a PR. Please read the template and fill out the checklist. Please make all diff --git a/docs/reference/asciidoc-document.md b/docs/reference/asciidoc-document.md index 2da3275..510799f 100644 --- a/docs/reference/asciidoc-document.md +++ b/docs/reference/asciidoc-document.md @@ -245,7 +245,7 @@ generates the following output: === input-with-pipe - Description: It includes v1 \| v2 \| v3 + Description: It includes v1 | v2 | v3 Type: `string` diff --git a/docs/reference/markdown-document.md b/docs/reference/markdown-document.md index fc5c97e..cd1b266 100644 --- a/docs/reference/markdown-document.md +++ b/docs/reference/markdown-document.md @@ -246,7 +246,7 @@ generates the following output: ### input-with-pipe - Description: It includes v1 \| v2 \| v3 + Description: It includes v1 | v2 | v3 Type: `string` diff --git a/scripts/docs/generate.go b/scripts/docs/generate.go index 265e83f..41cf70d 100644 --- a/scripts/docs/generate.go +++ b/scripts/docs/generate.go @@ -179,8 +179,7 @@ func example(ref *reference) error { ShowHeader: true, HeaderFromFile: "main.tf", SortBy: &terraform.SortBy{ - Name: true, - Required: true, + Name: true, }, }