add comments explaining use of CustomizeDiff

PagerDuty · Feb 14, 2023 · f850d9b · f850d9b
1 parent fd7355d
commit f850d9b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/pagerduty/resource_pagerduty_custom_field_option.go b/pagerduty/resource_pagerduty_custom_field_option.go
@@ -18,6 +18,8 @@ func resourcePagerDutyCustomFieldOption() *schema.Resource {
 		UpdateContext: resourcePagerDutyCustomFieldOptionUpdate,
 		DeleteContext: resourcePagerDutyCustomFieldOptionDelete,
 		CreateContext: resourcePagerDutyCustomFieldOptionCreate,
+		// this function does not actually customize the diff but uses this hook
+		// to validate the combination of datatype and value.
 		CustomizeDiff: validateCustomFieldOptionValue,
 		Schema: map[string]*schema.Schema{
 			"field": {

diff --git a/pagerduty/resource_pagerduty_custom_field_schema_field_configuration.go b/pagerduty/resource_pagerduty_custom_field_schema_field_configuration.go
@@ -19,6 +19,9 @@ func resourcePagerDutyCustomFieldSchemaFieldConfiguration() *schema.Resource {
 		UpdateContext: resourcePagerDutyCustomFieldSchemaFieldConfigurationUpdate,
 		DeleteContext: resourcePagerDutyCustomFieldSchemaFieldConfigurationDelete,
 		CreateContext: resourcePagerDutyCustomFieldSchemaFieldConfigurationCreate,
+		// this function does not actually customize the diff but uses this hook
+		// to validate the combination of required and the default_value prefixed
+		// attributes
 		CustomizeDiff: validateCustomFieldsForSchema,
 		Schema: map[string]*schema.Schema{
 			"schema": {