Skip to content

Commit 9dfe15c

Browse files
authored
Clarify prefix of provider name in README (#242)
1 parent 12a6bfd commit 9dfe15c

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,9 @@ Otherwise, the provider developer can set an arbitrary description like this:
103103

104104
The generation of missing documentation is based on a number of assumptions / conventional paths.
105105

106+
> **NOTE:** In the following conventional paths, `<data source name>` and `<resource name>` include the provider prefix as well.
107+
> For example, the data source [`caller_identity`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) in the `aws` provider would have an "example" conventional path of: `examples/data-sources/aws_caller_identity/data-source.tf`
108+
106109
For templates:
107110

108111
| Path | Description |

0 commit comments

Comments
 (0)