Skip to content

Commit 59e9453

Browse files
committed
Add godoc note to stringvalidator
1 parent c7d0a1e commit 59e9453

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

stringvalidator/prefer_write_only_attribute.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ import (
2121
// This implements the validation logic declaratively within the schema.
2222
// Refer to [resourcevalidator.PreferWriteOnlyAttribute]
2323
// for declaring this type of validation outside the schema definition.
24+
//
25+
// NOTE: This validator will produce persistent warnings for practitioners on every Terraform run as long as the specified non-write-only attribute
26+
// has a value in the configuration. The validator will also produce warnings for users of shared modules who cannot immediately take action on the warning.
2427
func PreferWriteOnlyAttribute(writeOnlyAttribute path.Expression) validator.String {
2528
return schemavalidator.PreferWriteOnlyAttribute{
2629
WriteOnlyAttribute: writeOnlyAttribute,

0 commit comments

Comments
 (0)