From 80ec2dd04d5b8a8250e28a6a00e24136d3f48aeb Mon Sep 17 00:00:00 2001 From: Maksym Vlasov Date: Wed, 11 May 2022 19:31:47 +0300 Subject: [PATCH] chore: Clarify `terraform-docs` config usage (#381) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 2ad16c2..61dfd7d 100644 --- a/README.md +++ b/README.md @@ -417,6 +417,8 @@ Unlike most other hooks, this hook triggers once if there are any changed files args: - --args=--config=.terraform-docs.yml + Note: Avoid use `recursive.enabled: true` in config file, that can cause unexpected behavior. + 5. If you need some exotic settings, it can be done too. I.e. this one generates HCL files: ```yaml