Skip to content

Commit

Permalink
Fixing docs (#668)
Browse files Browse the repository at this point in the history
  • Loading branch information
bendbennett committed Feb 10, 2023
1 parent 8c30700 commit 7da348d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions resource/schema/planmodifier/bool.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"
)

// Bool is a schema validator for types.Bool attributes.
// Bool is a schema plan modifier for types.Bool attributes.
type Bool interface {
Describer

Expand Down Expand Up @@ -78,8 +78,8 @@ type BoolResponse struct {
// attributes.
Private *privatestate.ProviderData

// Diagnostics report errors or warnings related to validating the data
// source configuration. An empty slice indicates success, with no warnings
// or errors generated.
// Diagnostics report errors or warnings related to modifying the resource
// configuration. An empty slice indicates success, with no warnings or
// errors generated.
Diagnostics diag.Diagnostics
}
10 changes: 5 additions & 5 deletions resource/schema/planmodifier/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@
// for framework-defined plan modifiers that can be used in
// provider-defined schemas.
//
// Each attr.Type has a corresponding {TYPE}PlanModifer interface which
// implements concretely typed Modify{TYPE} methods, such as
// StringPlanModifer and ModifyString.
// Each attr.Type has a corresponding {TYPE} interface which
// implements concretely typed PlanModify{TYPE} methods, such as
// StringPlanModifier and PlanModifyString.
//
// The framework has to choose between plan modifier developers handling a
// concrete framework value type, such as types.Bool, or the framework
// interface for custom value basetypes. such as basetypes.BoolValuable.
// interface for custom value basetypes, such as basetypes.BoolValuable.
//
// In the framework type model, the developer can immediately use the value.
// If the value was associated with a custom type and using the custom value
// type is desired, the developer must use the type's ValueFrom{TYPE} method.
//
// In the custom type model, the developer must always convert to a concreate
// In the custom type model, the developer must always convert to a concrete
// type before using the value unless checking for null or unknown. Since any
// custom type may be passed due to the schema, it is possible, if not likely,
// that unknown concrete types will be passed to the plan modifier.
Expand Down

0 comments on commit 7da348d

Please sign in to comment.