Terraform

Terraform

By DeepSource

variable declaration without description TF-L0042

Anti-pattern

Since description is optional value, it is not always necessary to write it. This issue is useful if you want to force the writing of description. Especially, when combined with terraform-docs.

Bad example

variable "no_description" {
  default = "value"
}

variable "empty_description" {
  default = "value"
  description = ""
}

variable "description" {
  default = "value"
  description = "This is description"
}