update doc comments

Author: austinvalle

ephemeral/close.go

@@ -23,7 +23,7 @@ type CloseRequest struct {
 // to the ephemeral resource's Close function, in which the provider
 // should set values on the CloseResponse as appropriate.
 type CloseResponse struct {
-	// Diagnostics report errors or warnings related to creating the
+	// Diagnostics report errors or warnings related to closing the
 	// resource. An empty slice indicates a successful operation with no
 	// warnings or errors generated.
 	Diagnostics diag.Diagnostics

ephemeral/configure.go

@@ -27,7 +27,7 @@ type ConfigureRequest struct {
 // EphemeralResource type Configure method.
 type ConfigureResponse struct {
 	// Diagnostics report errors or warnings related to configuring of the
-	// Datasource. An empty slice indicates a successful operation with no
+	// EphemeralResource. An empty slice indicates a successful operation with no
 	// warnings or errors generated.
 	Diagnostics diag.Diagnostics
 }

ephemeral/deferred.go

@@ -8,7 +8,7 @@ const (
 	// Provider developers should not use it.
 	DeferredReasonUnknown DeferredReason = 0
 
-	// DeferredReasonEphemeralResourceConfigUnknown is used to indicate that the ephemeral resource configuration
+	// DeferredReasonEphemeralResourceConfigUnknown is used to indicate that the resource configuration
 	// is partially unknown and the real values need to be known before the change can be planned.
 	DeferredReasonEphemeralResourceConfigUnknown DeferredReason = 1
 

ephemeral/ephemeral_resource.go

@@ -53,7 +53,7 @@ type EphemeralResourceWithRenew interface {
 
 // EphemeralResourceWithClose is an interface type that extends
 // EphemeralResource to include a method which the framework will call when
-// Terraform determines that the ephemeral values can be safely cleaned up.
+// Terraform determines that the ephemeral resource can be safely cleaned up.
 type EphemeralResourceWithClose interface {
 	EphemeralResource
 
@@ -76,7 +76,7 @@ type EphemeralResourceWithConfigure interface {
 
 // EphemeralResourceWithConfigValidators is an interface type that extends EphemeralResource to include declarative validations.
 //
-// Declaring validation using this methodology simplifies implmentation of
+// Declaring validation using this methodology simplifies implementation of
 // reusable functionality. These also include descriptions, which can be used
 // for automating documentation.
 //

ephemeral/open.go

@@ -50,6 +50,8 @@ type OpenResponse struct {
 	// Open operation. This field is not pre-populated as there is no
 	// pre-existing private state data during the ephemeral resource's
 	// Open operation.
+	//
+	// This private data will be passed to any Renew or Close operations.
 	Private *privatestate.ProviderData
 
 	// RenewAt is an optional date/time field that indicates to Terraform
@@ -62,7 +64,7 @@ type OpenResponse struct {
 	// skew.
 	RenewAt time.Time
 
-	// Diagnostics report errors or warnings related to creating the
+	// Diagnostics report errors or warnings related to opening the ephemeral
 	// resource. An empty slice indicates a successful operation with no
 	// warnings or errors generated.
 	Diagnostics diag.Diagnostics

ephemeral/renew.go

@@ -41,9 +41,11 @@ type RenewResponse struct {
 	// Private is the private state ephemeral resource data following the
 	// Renew operation. This field is pre-populated from RenewRequest.Private
 	// and can be modified during the ephemeral resource's Renew operation.
+	//
+	// This private data will be passed to any Renew or Close operations.
 	Private *privatestate.ProviderData
 
-	// Diagnostics report errors or warnings related to creating the
+	// Diagnostics report errors or warnings related to renewing the ephemeral
 	// resource. An empty slice indicates a successful operation with no
 	// warnings or errors generated.
 	Diagnostics diag.Diagnostics

ephemeral/schema.go

@@ -19,8 +19,8 @@ type SchemaResponse struct {
 	// Schema is the schema of the ephemeral resource.
 	Schema schema.Schema
 
-	// Diagnostics report errors or warnings related to validating the data
-	// source configuration. An empty slice indicates success, with no warnings
+	// Diagnostics report errors or warnings related to retrieving the ephemeral
+	// resource schema. An empty slice indicates success, with no warnings
 	// or errors generated.
 	Diagnostics diag.Diagnostics
 }

ephemeral/schema/bool_attribute.go

@@ -55,9 +55,7 @@ type BoolAttribute struct {
 
 	// Sensitive indicates whether the value of this attribute should be
 	// considered sensitive data. Setting it to true will obscure the value
-	// in CLI output. Sensitive does not impact how values are stored, and
-	// practitioners are encouraged to store their state as if the entire
-	// file is sensitive.
+	// in CLI output.
 	Sensitive bool
 
 	// Description is used in various tooling, like the language server, to

ephemeral/schema/doc.go

@@ -3,6 +3,6 @@
 
 // Package schema contains all available schema functionality for ephemeral resources.
 // Ephemeral resource schemas define the structure and value types for configuration
-// and state data. Schemas are implemented via the ephemeral.EphemeralResource type
+// and result data. Schemas are implemented via the ephemeral.EphemeralResource type
 // Schema method.
 package schema

ephemeral/schema/dynamic_attribute.go

@@ -56,9 +56,7 @@ type DynamicAttribute struct {
 
 	// Sensitive indicates whether the value of this attribute should be
 	// considered sensitive data. Setting it to true will obscure the value
-	// in CLI output. Sensitive does not impact how values are stored, and
-	// practitioners are encouraged to store their state as if the entire
-	// file is sensitive.
+	// in CLI output.
 	Sensitive bool
 
 	// Description is used in various tooling, like the language server, to