Improve comment about how plugin-framework provider is configured (#11442) (#19142)

modular-magician · web-flow · commit 3a3492aa75bb · 2024-08-14T14:57:08.000-07:00
[upstream:f34f5c63183b8584360c5a0468328f710057645d]

Signed-off-by: Modular Magician &lt;magic-modules@google.com&gt;
diff --git a/.changelog/11442.txt b/.changelog/11442.txt
@@ -0,0 +1,3 @@
+```release-note:none
+
+```
diff --git a/google/fwprovider/framework_provider.go b/google/fwprovider/framework_provider.go
@@ -967,7 +967,8 @@ func (p *FrameworkProvider) Configure(ctx context.Context, req provider.Configur
 		return
 	}
 
-	// Example client configuration for data sources and resources
+	// This is how we make provider configuration info (configured clients, default project, etc) available to resources and data sources
+	// implemented using the plugin-framework. The resources' Configure functions receive this data in the ConfigureRequest argument.
 	resp.DataSourceData = &p.FrameworkProviderConfig
 	resp.ResourceData = &p.FrameworkProviderConfig
 }

Original file line number	Diff line number	Diff line change
`@@ -967,7 +967,8 @@ func (p *FrameworkProvider) Configure(ctx context.Context, req provider.Configur`
`967`	`967`	`return`
`968`	`968`	`}`
`969`	`969`
`970`		`- // Example client configuration for data sources and resources`
	`970`	`+ // This is how we make provider configuration info (configured clients, default project, etc) available to resources and data sources`
	`971`	`+ // implemented using the plugin-framework. The resources' Configure functions receive this data in the ConfigureRequest argument.`
`971`	`972`	`resp.DataSourceData = &p.FrameworkProviderConfig`
`972`	`973`	`resp.ResourceData = &p.FrameworkProviderConfig`
`973`	`974`	`}`