mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
Deprecate Settings and Options in favor of Config
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
This commit is contained in:
Khosrow Moossavi
@@ -16,14 +16,14 @@
|
||||
| number-1 | It's number number one. | `number` | `42` |
|
||||
| map-3 | n/a | `map` | `{}` |
|
||||
| map-2 | It's map number two. | `map` | n/a |
|
||||
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
|
||||
| map-1 | It's map number one. | `map` | ```{ "a": 1, "b": 2, "c": 3 }``` |
|
||||
| list-3 | n/a | `list` | `[]` |
|
||||
| list-2 | It's list number two. | `list` | n/a |
|
||||
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
|
||||
| list-1 | It's list number one. | `list` | ```[ "a", "b", "c" ]``` |
|
||||
| input_with_underscores | A variable with underscores. | `any` | n/a |
|
||||
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
|
||||
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
|
||||
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
|
||||
| input-with-code-block | This is a complicated one. We need a newline. And an example in a code block ```default = [ "machine rack01:neptune" ]``` | `list` | ```[ "name rack:location" ]``` |
|
||||
| long_type | This description is itself markdown. It spans over multiple lines. | ```object({ name = string, foo = object({ foo = string, bar = string }), bar = object({ foo = string, bar = string }), fizz = list(string), buzz = list(string) })``` | ```{ "bar": { "bar": "bar", "foo": "bar" }, "buzz": [ "fizz", "buzz" ], "fizz": [], "foo": { "bar": "foo", "foo": "foo" }, "name": "hello" }``` |
|
||||
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
|
||||
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` |
|
||||
| string_default_empty | n/a | `string` | `""` |
|
||||
|
||||
119
format/testdata/tfvars/hcl-PrintDescription.golden
vendored
119
format/testdata/tfvars/hcl-PrintDescription.golden
vendored
@@ -1,30 +1,59 @@
|
||||
|
||||
# A variable with underscores.
|
||||
input_with_underscores = ""
|
||||
|
||||
# It's list number two.
|
||||
list-2 = ""
|
||||
|
||||
# It's map number two.
|
||||
map-2 = ""
|
||||
|
||||
# It's number number two.
|
||||
number-2 = ""
|
||||
|
||||
# It's string number two.
|
||||
string-2 = ""
|
||||
|
||||
string_no_default = ""
|
||||
unquoted = ""
|
||||
|
||||
# It's bool number one.
|
||||
bool-1 = true
|
||||
unquoted = ""
|
||||
bool-3 = true
|
||||
|
||||
# It's bool number two.
|
||||
bool-2 = false
|
||||
|
||||
bool-3 = true
|
||||
bool_default_false = false
|
||||
# It's bool number one.
|
||||
bool-1 = true
|
||||
|
||||
string-3 = ""
|
||||
|
||||
# It's string number two.
|
||||
string-2 = ""
|
||||
|
||||
# It's string number one.
|
||||
string-1 = "bar"
|
||||
|
||||
string-special-chars = "\\.<>[]{}_-"
|
||||
number-3 = "19"
|
||||
number-4 = 15.75
|
||||
|
||||
# It's number number two.
|
||||
number-2 = ""
|
||||
|
||||
# It's number number one.
|
||||
number-1 = 42
|
||||
|
||||
map-3 = {}
|
||||
|
||||
# It's map number two.
|
||||
map-2 = ""
|
||||
|
||||
# It's map number one.
|
||||
map-1 = {
|
||||
"a": 1,
|
||||
"b": 2,
|
||||
"c": 3
|
||||
}
|
||||
|
||||
list-3 = []
|
||||
|
||||
# It's list number two.
|
||||
list-2 = ""
|
||||
|
||||
# It's list number one.
|
||||
list-1 = [
|
||||
"a",
|
||||
"b",
|
||||
"c"
|
||||
]
|
||||
|
||||
# A variable with underscores.
|
||||
input_with_underscores = ""
|
||||
|
||||
# It includes v1 | v2 | v3
|
||||
input-with-pipe = "v1"
|
||||
|
||||
# This is a complicated one. We need a newline.
|
||||
# And an example in a code block
|
||||
@@ -38,19 +67,6 @@ input-with-code-block = [
|
||||
"name rack:location"
|
||||
]
|
||||
|
||||
# It includes v1 | v2 | v3
|
||||
input-with-pipe = "v1"
|
||||
|
||||
# It's list number one.
|
||||
list-1 = [
|
||||
"a",
|
||||
"b",
|
||||
"c"
|
||||
]
|
||||
|
||||
list-3 = []
|
||||
list_default_empty = []
|
||||
|
||||
# This description is itself markdown.
|
||||
#
|
||||
# It spans over multiple lines.
|
||||
@@ -72,33 +88,16 @@ long_type = {
|
||||
"name": "hello"
|
||||
}
|
||||
|
||||
# It's map number one.
|
||||
map-1 = {
|
||||
"a": 1,
|
||||
"b": 2,
|
||||
"c": 3
|
||||
}
|
||||
|
||||
map-3 = {}
|
||||
|
||||
# The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'.
|
||||
no-escape-default-value = "VALUE_WITH_UNDERSCORE"
|
||||
|
||||
# It's number number one.
|
||||
number-1 = 42
|
||||
# The description contains url. https://www.domain.com/foo/bar_baz.html
|
||||
with-url = ""
|
||||
|
||||
number-3 = "19"
|
||||
number-4 = 15.75
|
||||
number_default_zero = 0
|
||||
object_default_empty = {}
|
||||
|
||||
# It's string number one.
|
||||
string-1 = "bar"
|
||||
|
||||
string-3 = ""
|
||||
string-special-chars = "\\.<>[]{}_-"
|
||||
string_default_empty = ""
|
||||
string_default_null = ""
|
||||
|
||||
# The description contains url. https://www.domain.com/foo/bar_baz.html
|
||||
with-url = ""
|
||||
string_no_default = ""
|
||||
number_default_zero = 0
|
||||
bool_default_false = false
|
||||
list_default_empty = []
|
||||
object_default_empty = {}
|
||||
Reference in New Issue
Block a user