Skip to content

Commit

Permalink
all: Add missing package-level Go documentation (hashicorp#394)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
bflad authored Jun 28, 2022
1 parent f98bd2b commit 133b0a4
Show file tree
Hide file tree
Showing 10 changed files with 31 additions and 0 deletions.
5 changes: 5 additions & 0 deletions diag/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// Package diag implements diagnostic functionality, which is a practitioner
// feedback mechanism for providers. It is designed for display in Terraform
// user interfaces, rather than logging based feedback, which is generally
// saved to a file for later inspection and troubleshooting.
package diag
3 changes: 3 additions & 0 deletions internal/logging/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
// Package logging contains framework internal helpers for consistent logger
// and log entry handling.
package logging
3 changes: 3 additions & 0 deletions internal/reflect/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
// Package reflect contains the implementation for converting framework-defined
// data into and from provider-defined Go types.
package reflect
2 changes: 2 additions & 0 deletions internal/testing/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Package testing contains internal framework helpers for unit testing.
package testing
2 changes: 2 additions & 0 deletions internal/testing/planmodifiers/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Package planmodifiers contains plan modifiers for testing.
package planmodifiers
2 changes: 2 additions & 0 deletions internal/testing/testprovider/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Package testprovider contains a fully declarative provider for testing.
package testprovider
3 changes: 3 additions & 0 deletions path/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
// Package path implements attribute path functionality, which defines
// transversals into schema-based data.
package path
4 changes: 4 additions & 0 deletions providerserver/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// Package providerserver implements functionality for serving a provider,
// such as directly starting a server in a production binary and conversion
// functions for testing.
package providerserver
3 changes: 3 additions & 0 deletions tfsdk/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
// Package tfsdk contains core framework functionality for data sources,
// providers, resources, schemas, and schema data.
package tfsdk
4 changes: 4 additions & 0 deletions types/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// Package types contains the framework-defined data types and values, such as
// boolean, floating point, integer, list, map, object, set, and string. These
// types can be extended by providers for custom use cases.
package types

0 comments on commit 133b0a4

Please sign in to comment.