Skip to content

Commit 5d02eba

Browse files
committed
docs: add requirement for supported arguments text in Arguments Reference section
1 parent 64cf3bf commit 5d02eba

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

contributing/topics/reference-documentation-standards.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ The following conventions apply to code fences:
7171

7272
The ``## Arguments Reference`` section is used to document fields that can be set by the user in the Terraform configuration.
7373

74+
Directly after the initial heading of ``## Arguments Reference`` you must include the exact text ``The following arguments are supported:``.
75+
7476
### Descriptions
7577

7678
The following conventions apply to argument descriptions:
@@ -118,6 +120,8 @@ Example:
118120
```markdown
119121
## Arguments Reference
120122

123+
The following arguments are supported:
124+
121125
* `name` - (Required) The name which should be used for this resource.
122126

123127
* `resource_group_name` - (Required) The name which should be used for this resource.

0 commit comments

Comments
 (0)