Small edit for style on a code comment (#975)

* Make the code comment match the tutorial code comment * Apply suggestions from code review Co-authored-by: Austin Valle <[email protected]> --------- Co-authored-by: Austin Valle <[email protected]>
hashicorp · Apr 4, 2024 · 541a7cb · 541a7cb
1 parent 484f311
commit 541a7cb
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/website/docs/plugin/framework/data-sources/configure.mdx b/website/docs/plugin/framework/data-sources/configure.mdx
@@ -66,8 +66,8 @@ type ThingDataSource struct {
 }
 
 func (d *ThingDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
-  // A nil check should always be performed when handling ProviderData as it
-  // is only set after the ConfigureProvider RPC has been called by Terraform.
+  // Always perform a nil check when handling ProviderData because Terraform
+  // sets that data after it calls the ConfigureProvider RPC.
   if req.ProviderData == nil {
     return
   }

diff --git a/website/docs/plugin/framework/resources/configure.mdx b/website/docs/plugin/framework/resources/configure.mdx
@@ -66,8 +66,8 @@ type ThingResource struct {
 }
 
 func (r *ThingResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
-  // A nil check should always be performed when handling ProviderData as it
-  // is only set after the ConfigureProvider RPC has been called by Terraform.
+  // Always perform a nil check when handling ProviderData because Terraform
+  // sets that data after it calls the ConfigureProvider RPC.
   if req.ProviderData == nil {
     return
   }