Merge pull request #25 from babbel/unify-variables

Unify structure of module variables

_test/main.tf

@@ -3,7 +3,7 @@ provider "aws" {
 }
 
 module "nlb" {
-  source  = "./.."
+  source = "./.."
 
   name = "example"
 

subnet/variables.tf

@@ -1,31 +1,41 @@
 variable "availability_zone" {
-  description = "Availability zone of the subnet"
-
   type = string
+
+  description = <<EOS
+Availability zone of the subnet.
+EOS
 }
 
 variable "cidr_block" {
-  description = "Subnet CIDR"
-
   type = string
+
+  description = <<EOS
+Subnet CIDR.
+EOS
 }
 
 variable "name" {
-  description = "Name of the NLB"
-
   type = string
+
+  description = <<EOS
+Name of the NLB.
+EOS
 }
 
 variable "tags" {
-  description = "Map of tags to assign to all resources supporting tags (in addition to the `Name` tag)"
-
   type = map(string)
+
+  description = <<EOS
+Map of tags assigned to all AWS resources created by this module.
+EOS
 }
 
 variable "vpc" {
-  description = "VPC where the subnet will be created"
-
   type = object({
     id = string
   })
+
+  description = <<EOS
+VPC where the subnet will be created.
+EOS
 }

variables.tf

@@ -1,26 +1,34 @@
 variable "cidr_blocks" {
-  description = "Map of subnet CIDRs by availability zone used by the NLB"
-
   type = map(string)
+
+  description = <<EOS
+Map of subnet CIDRs by availability zone used by the NLB.
+EOS
 }
 
 variable "name" {
-  description = "Name of the NLB"
-
   type = string
+
+  description = <<EOS
+Name of the NLB.
+EOS
 }
 
 variable "tags" {
-  description = "Map of tags to assign to all resources supporting tags (in addition to the `Name` tag)"
-
   type    = map(string)
   default = {}
+
+  description = <<EOS
+Map of tags assigned to all AWS resources created by this module.
+EOS
 }
 
 variable "vpc" {
-  description = "VPC where the NLB and the subnets will be created"
-
   type = object({
     id = string
   })
+
+  description = <<EOS
+VPC where the NLB and the subnets will be created.
+EOS
 }