From d1d7e5f90f3b7be352d964894d222633b22e1e49 Mon Sep 17 00:00:00 2001 From: Brian Flad Date: Wed, 25 May 2022 10:11:57 -0400 Subject: [PATCH] all: Add package level Go documentation and fix int64validator package naming in source files Reference: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework-validators This will improve the usability of browsing the Go documentation. --- float64validator/doc.go | 2 ++ int64validator/at_least.go | 2 +- int64validator/at_least_test.go | 2 +- int64validator/at_most.go | 2 +- int64validator/at_most_test.go | 2 +- int64validator/between.go | 2 +- int64validator/between_test.go | 2 +- int64validator/doc.go | 2 ++ stringvalidator/doc.go | 2 ++ validatordiag/doc.go | 3 +++ 10 files changed, 15 insertions(+), 6 deletions(-) create mode 100644 float64validator/doc.go create mode 100644 int64validator/doc.go create mode 100644 stringvalidator/doc.go create mode 100644 validatordiag/doc.go diff --git a/float64validator/doc.go b/float64validator/doc.go new file mode 100644 index 00000000..652b83e6 --- /dev/null +++ b/float64validator/doc.go @@ -0,0 +1,2 @@ +// Package float64validator provides validators for types.Float64 attributes. +package float64validator diff --git a/int64validator/at_least.go b/int64validator/at_least.go index c5938031..894aa789 100644 --- a/int64validator/at_least.go +++ b/int64validator/at_least.go @@ -1,4 +1,4 @@ -package validate +package int64validator import ( "context" diff --git a/int64validator/at_least_test.go b/int64validator/at_least_test.go index 4db0c898..5763a12e 100644 --- a/int64validator/at_least_test.go +++ b/int64validator/at_least_test.go @@ -1,4 +1,4 @@ -package validate +package int64validator import ( "context" diff --git a/int64validator/at_most.go b/int64validator/at_most.go index 14f0a1eb..5bb30761 100644 --- a/int64validator/at_most.go +++ b/int64validator/at_most.go @@ -1,4 +1,4 @@ -package validate +package int64validator import ( "context" diff --git a/int64validator/at_most_test.go b/int64validator/at_most_test.go index 8aa327de..5302eed0 100644 --- a/int64validator/at_most_test.go +++ b/int64validator/at_most_test.go @@ -1,4 +1,4 @@ -package validate +package int64validator import ( "context" diff --git a/int64validator/between.go b/int64validator/between.go index e8fd7d02..cb590f1a 100644 --- a/int64validator/between.go +++ b/int64validator/between.go @@ -1,4 +1,4 @@ -package validate +package int64validator import ( "context" diff --git a/int64validator/between_test.go b/int64validator/between_test.go index e9106b76..f0126ee7 100644 --- a/int64validator/between_test.go +++ b/int64validator/between_test.go @@ -1,4 +1,4 @@ -package validate +package int64validator import ( "context" diff --git a/int64validator/doc.go b/int64validator/doc.go new file mode 100644 index 00000000..243d42d0 --- /dev/null +++ b/int64validator/doc.go @@ -0,0 +1,2 @@ +// Package int64validator provides validators for types.Int64 attributes. +package int64validator diff --git a/stringvalidator/doc.go b/stringvalidator/doc.go new file mode 100644 index 00000000..1ba12e16 --- /dev/null +++ b/stringvalidator/doc.go @@ -0,0 +1,2 @@ +// Package stringvalidator provides validators for types.String attributes. +package stringvalidator diff --git a/validatordiag/doc.go b/validatordiag/doc.go new file mode 100644 index 00000000..372bd460 --- /dev/null +++ b/validatordiag/doc.go @@ -0,0 +1,3 @@ +// Package validatordiag provides diagnostics helpers for validator +// implementations. +package validatordiag