-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Cannot validate resource with no exported attributes #43
Comments
Just for the brief history here: this type of checking was originally created as every Terraform Plugin SDK resource implicitly had an I think the preference here would be to always check for the header, since it would be good to check for accidental omissions. However, we could allow an additional byline similar to the one you mention: Would this be sufficient or would you prefer the bylines be configurable? |
Hey @bflad, that makes total sense and it's logical that resources would typically set at least one attribute. I guess greater prescription makes more sense and personally I'd still want to include the heading so that it doesn't just look like it was forgotten. Allowing an alternative byline like that would be great for this sort of case 👍 |
Awesome -- should be relatively straightforward to accept the alternate line by default. 😄 |
…tributes are exported.` Reference: #43
Released in v0.9.1 🚀 |
Docs for resources that don't have, or wish to, document any exported attributes, since they are identical to the arguments, cannot be validated by
tfproviderdocs check
.If no
## Attributes Reference
header exists, it reports:If the header is included but has alternative paragraph text:
Could this check be made togglable so that the docs can still be otherwise checked?
The text was updated successfully, but these errors were encountered: