fix: Added function docs

Signed-off-by: Sam Plant <[email protected]>

pkg/tfc_trigger/project_config.go

@@ -24,6 +24,12 @@ type ProjectConfig struct {
 	Workspaces []*TFCWorkspace `yaml:"workspaces"`
 }
 
+// Finds the workspace with the deepest matching directory suffix.
+// For example, given workspaces with config "terraform/dev/" and a dir of "dev/",
+// and a filepath directory of "filesystem/terraform/dev/" - "dev" and "terraform/dev/" are both a suffix 
+// we would return the ws for "terraform/dev/"as it is the deepest match.
+// Special case: if a workspace has config "/" and the input dir is ".", that workspace is returned.
+// If no workspace matches, returns nil.
 func (cfg *ProjectConfig) workspaceForDir(dir string) *TFCWorkspace {
 	var longestMatch *TFCWorkspace
 	var longestMatchDepth int