Skip to content

Commit a02e8e5

Browse files
committed
docs: update argument descriptions for clarity and consistency
1 parent 5d02eba commit a02e8e5

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

contributing/topics/reference-documentation-standards.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -80,17 +80,17 @@ The following conventions apply to argument descriptions:
8080
- Descriptions should be concise, avoid adding too much detail, links to external documentation, etc. If more detail must be added, use a [note](#notes).
8181
- If an argument has `ForceNew: true`, its description must end with `Changing this forces a new resource to be created.`
8282
- If the argument has a default value, this must be documented using `` Defaults to `default1`. ``
83-
- If the argument has validation allowing only specific inputs, e.g. `validation.StringInSlice()`, these must be documented using `` Possible values are `value1`, `value2`, and `value3. ``.
83+
- If the argument has validation allowing only specific inputs, e.g. `validation.StringInSlice()`, these must be documented using `` Possible values are `valueOne`, `valueTwo`, and `valueThree`. ``.
8484
* Other common entries include:
85-
- Arguments with a single allowed value: `` The only possible value is `value1`. ``
85+
- Arguments with a single allowed value: `` The only possible value is `valueOne`. ``
8686
- Arguments allowing a range of values, e.g. `validation.IntBetween()`: `` Possible values range between `1` and `100`. ``
8787

8888

8989
Examples:
9090

91-
- `name` - (Required) The name which should be used for this resource.
92-
- `argument_enabled` - (Optional) Should this argument be enabled? Possible values are `true` and `false`. Defaults to `false`.
93-
- `argument_in_gb` - (Optional) The argument in gigabytes. Possible values range between `4` and `256`.
91+
- `name` - (Required) The name which should be used for this resource. Changing this forces a new resource to be created.
92+
- `argument_enabled` - (Optional) Whether the `argument` is enabled. Defaults to `false`.
93+
- `argument_in_gb` - (Optional) The argument in gigabytes. Possible values range between `4` and `256`. Defaults to `129`.
9494

9595
### Ordering
9696

@@ -122,29 +122,35 @@ Example:
122122

123123
The following arguments are supported:
124124

125-
* `name` - (Required) The name which should be used for this resource.
125+
* `name` - (Required) The name which should be used for this resource. Changing this forces a new resource to be created.
126126

127-
* `resource_group_name` - (Required) The name which should be used for this resource.
127+
-> **Note:** The `name` must begin and end with an alphanumeric character, and may contain only alphanumeric characters and hyphens.
128128

129-
* `location` - (Required) The name which should be used for this resource.
129+
* `resource_group_name` - (Required) The name of the Resource Group where the resource should exist. Changing this forces a new resource to be created.
130130

131-
* `argument` - (Required) This argument does something nifty.
131+
* `location` - (Required) The Azure Region where the resource should exist. Changing this forces a new resource to be created.
132+
133+
* `argument` - (Required) This argument does something nifty. Possible values are `nifty`, `super-nifty`, and `stupendous`.
132134

133135
* `block_argument` - (Optional) A `block_argument` as defined below.
134136

135-
* `some_other_argument` - (Optional) This argument does something magical.
137+
* `some_other_argument` - (Optional) This argument does something magical. Possible values are `magical` or `muggle`. Defaults to `magical`.
138+
139+
* `tags` - (Optional) Specifies a mapping of tags to assign to the resource.
136140

137141
---
138142

139143
A `block_argument` supports the following:
140144

141-
* `block_argument` - (Required) Specifies the block_argument of this nested item.
145+
* `argument` - (Required) The argument that should be used for this block argument. Possible values are `this`, `that`, and `other`.
146+
147+
* `some_other_block_argument` - (Required) Specifies the some other block argument. The only possible value is `value`.
142148

143-
* `some_other_block_argument` - (Required) Specifies the some_other_block_argument of this nested item exists.
149+
* `optional_block_argument` - (Optional) The optional block argument for the resource. Possible values range between `1` and `2048`. Defaults to `1024`.
144150

145-
* `optional_block_argument` - (Optional) Specifies the optional_block_argument of this nested item exists.
151+
* `some_other_optional_block_argument` - (Optional) Specifies the some other optional block argument. Defaults to `false`.
146152

147-
* `some_other_optional_block_argument` - (Optional) Specifies the some_other_optional_block_argument of this nested item exists.
153+
~> **Note:** The argument `some_other_optional_block_argument` is required when `argument` is set to `stupendous`.
148154

149155
## Attributes Reference
150156

@@ -254,7 +260,7 @@ To add a warning note, use `~> **Note:**`, within the Terraform registry documen
254260
For example, an argument that is optional but required when another argument is set to `true`:
255261

256262
```markdown
257-
* `optional_argument_enabled` - (Optional) Is the optional argument enabled? Defaults to `false`.
263+
* `optional_argument_enabled` - (Optional) Whether the `optional argument` is enabled. Defaults to `false`.
258264

259265
* `optional_argument` - (Optional) An optional argument.
260266

@@ -270,7 +276,7 @@ To add a caution note, use `!> **Note:**`, within the Terraform registry documen
270276
For example, an argument that when set to `true` cannot be reversed without recreating the resource:
271277

272278
```markdown
273-
* `irreversible_argument_enabled` - (Optional) Is irreversible argument enabled? Defaults to `false`.
279+
* `irreversible_argument_enabled` - (Optional) Whether the `irreversible argument` is enabled. Defaults to `false`.
274280

275281
!> **Note:** The argument `irreversible_argument_enabled` cannot be disabled after being enabled.
276282
```

0 commit comments

Comments
 (0)