Apply suggestions from code review

Co-authored-by: Dennis Ploeger <[email protected]>

Author: kpshjk

README.md

@@ -84,7 +84,7 @@ Default: `""`
 
 ### set-list
 
-Description: A list of settings to apply to on the helm chart using its parameter 'set { }'. Example:
+Description: A list of additional settings to apply to the helm chart using the terraform `set{}` parameter. Example:
 ```
   set-list = [
     {
@@ -95,13 +95,21 @@ Description: A list of settings to apply to on the helm chart using its paramete
   ]
 ```
 
-Type: `list(object({name = string, value = string, type = string}))`
+Type:
+
+```hcl
+list(object({
+    name  = string,
+    value = string,
+    type  = string,
+  }))
+```
 
 Default: `[]`
 
 ### values
 
-Description: A list of values to apply on the helm chart using its parameter 'values = [...]'. Example:
+Description: A list of additional values to apply to the helm chart using the  'values = [...]' parameter. Example:
 ```
   values = [
     "<yaml>",
@@ -112,8 +120,6 @@ Type: `list(string)`
 
 Default: `[]`
 
-###
-
 ## Outputs
 
 No outputs.

main.tf

@@ -18,11 +18,11 @@ resource "helm_release" "cert-manager" {
   }
 
   dynamic "set" {
-  for_each = var.set-list
+    for_each = var.set-list
     content {
-      name = lookup(set.value, "name", null)
+      name  = lookup(set.value, "name", null)
       value = lookup(set.value, "value", null)
-      type = lookup(set.value, "type", null)
+      type  = lookup(set.value, "type", null)
     }
   }
 

vars.tf

@@ -24,16 +24,34 @@ variable "cluster-issuers-yaml" {
 
 variable "set-list" {
   type = list(object({
-    name = string,
+    name  = string,
     value = string,
-    type = string,
+    type  = string,
   }))
-  default = []
-  description = "A list of settings to apply to on the helm chart using its parameter 'set { }' "
+  default     = []
+  description = <<EOT
+A list of additional settings to apply to the helm chart using the terraform `set{}` parameter. Example:
+```
+  set-list = [
+    {
+      "name"  = "prometheus.enabled",
+      "value" = "false",
+      "type"  = "auto"
+    },
+  ]
+```
+EOT
 }
 
 variable "values" {
-  type = list(string)
-  default = []
-  description = "A list of values to apply on the helm chart using its parameter 'values = [...]' "
+  type        = list(string)
+  default     = []
+  description = <<EOT
+A list of additional values to apply to the helm chart using the  'values = [...]' parameter. Example:
+```
+  values = [
+    "<yaml>",
+  ]
+```
+EOT
 }