Skip to content

Commit

Permalink
Add better comments for all the variables
Browse files Browse the repository at this point in the history
  • Loading branch information
yorinasub17 committed Jun 6, 2019
1 parent 1cfcc1e commit d15e1c8
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion modules/join-path/vars.tf
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ variable "path_parts" {
type = list(string)

# Example:
# default = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
# path_parts = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
}
6 changes: 3 additions & 3 deletions modules/prepare-pex-environment/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@ variable "python2_pex_path_parts" {
description = "Parts of the path (folders and files names) to the PEX executable for python 2 as a list of strings."
type = list(string)
# Example:
# default = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
# python2_pex_path_parts = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
}

variable "python3_pex_path_parts" {
description = "Parts of the path (folders and files names) to the PEX executable for python 3 as a list of strings."
type = list(string)
# Example:
# default = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
# python3_pex_path_parts = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
}

variable "pex_module_path_parts" {
description = "Parts of the path (folders and file names) to the python package directory housing the pex file."
type = list(string)
# Example:
# default = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
# pex_module_path_parts = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
}
10 changes: 6 additions & 4 deletions modules/run-pex-as-data-source/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@ variable "python2_pex_path_parts" {
description = "Parts of the path (folders and files names) to the PEX executable for python 2 as a list of strings."
type = list(string)
# Example:
# default = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
# python2_pex_path_parts = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
}

variable "python3_pex_path_parts" {
description = "Parts of the path (folders and files names) to the PEX executable for python 3 as a list of strings."
type = list(string)
# Example:
# default = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
# python3_pex_path_parts = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
}

variable "pex_module_path_parts" {
description = "Parts of the path (folders and file names) to the python package directory housing the pex file."
type = list(string)
# Example:
# default = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
# pex_module_path_parts = ["foo", "bar", "baz.txt"] => outputs "foo/bar/baz.txt" on Linux
}

variable "script_main_function" {
Expand All @@ -27,7 +27,9 @@ variable "script_main_function" {
variable "command_args" {
description = "The arguments to pass to the command as a string"
type = string
default = ""

# We don't use null here because this is interpolated into the python script.
default = ""
}

variable "command_query" {
Expand Down
4 changes: 3 additions & 1 deletion modules/run-pex-as-resource/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,7 @@ variable "script_main_function" {
variable "command_args" {
description = "The arguments to pass to the command as a string"
type = string
default = ""

# We don't use null here because this is interpolated into the python script.
default = ""
}

0 comments on commit d15e1c8

Please sign in to comment.