From fc6c305813623fc02eed7b02732d149468f9b99a Mon Sep 17 00:00:00 2001
From: Nick Fagerlund <nick.fagerlund@gmail.com>
Date: Wed, 1 Nov 2023 16:30:19 -0700
Subject: [PATCH] Document testAccCheckTFEWorkspaceAttributes helper

---
 internal/provider/resource_tfe_workspace_test.go | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/internal/provider/resource_tfe_workspace_test.go b/internal/provider/resource_tfe_workspace_test.go
index 4ee7cc6ed..3cb068b0c 100644
--- a/internal/provider/resource_tfe_workspace_test.go
+++ b/internal/provider/resource_tfe_workspace_test.go
@@ -2296,6 +2296,10 @@ func testAccCheckTFEWorkspaceHasRemoteConsumers(ws string, wsConsumers []string)
 	}
 }
 
+// Helper that checks the actual workspace attribute values in the remote
+// service (as opposed to just checking the terraform resource state). This
+// makes hardcoded assumptions about the attribute values in the configuration,
+// so it can only be used with configs that match those assumptions.
 func testAccCheckTFEWorkspaceAttributes(
 	workspace *tfe.Workspace) resource.TestCheckFunc {
 	return func(s *terraform.State) error {