Skip to content

Commit 133b0a4

Browse files
authored
all: Add missing package-level Go documentation (#394)
Reference: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework This ensures all current Go packages have Go comment-based documentation for display in editors and on the pkg.go.dev website.
1 parent f98bd2b commit 133b0a4

10 files changed

Lines changed: 31 additions & 0 deletions

File tree

diag/doc.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
// Package diag implements diagnostic functionality, which is a practitioner
2+
// feedback mechanism for providers. It is designed for display in Terraform
3+
// user interfaces, rather than logging based feedback, which is generally
4+
// saved to a file for later inspection and troubleshooting.
5+
package diag

internal/logging/doc.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// Package logging contains framework internal helpers for consistent logger
2+
// and log entry handling.
3+
package logging

internal/reflect/doc.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// Package reflect contains the implementation for converting framework-defined
2+
// data into and from provider-defined Go types.
3+
package reflect

internal/testing/doc.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package testing contains internal framework helpers for unit testing.
2+
package testing
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package planmodifiers contains plan modifiers for testing.
2+
package planmodifiers
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package testprovider contains a fully declarative provider for testing.
2+
package testprovider

path/doc.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// Package path implements attribute path functionality, which defines
2+
// transversals into schema-based data.
3+
package path

providerserver/doc.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
// Package providerserver implements functionality for serving a provider,
2+
// such as directly starting a server in a production binary and conversion
3+
// functions for testing.
4+
package providerserver

tfsdk/doc.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// Package tfsdk contains core framework functionality for data sources,
2+
// providers, resources, schemas, and schema data.
3+
package tfsdk

types/doc.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
// Package types contains the framework-defined data types and values, such as
2+
// boolean, floating point, integer, list, map, object, set, and string. These
3+
// types can be extended by providers for custom use cases.
4+
package types

0 commit comments

Comments
 (0)