From ed43b19693da7aeb6fa4f7b9523330415a7bffbc Mon Sep 17 00:00:00 2001
From: Yordis Prieto <yordis.prieto@gmail.com>
Date: Sat, 1 Jun 2024 17:59:56 -0400
Subject: [PATCH] chore: improve references docs

---
 pkg/config/resource.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/pkg/config/resource.go b/pkg/config/resource.go
index e7002629..b39e8792 100644
--- a/pkg/config/resource.go
+++ b/pkg/config/resource.go
@@ -167,6 +167,9 @@ type ExternalName struct {
 
 // References represents reference resolver configurations for the fields of a
 // given resource. Key should be the field path of the field to be referenced.
+// The key is the Terraform field path of the field to be referenced.
+// Example: "vpc_id" or "forwarding_rule.certificate_name" in case of nested
+// in another object.
 type References map[string]Reference
 
 // Reference represents the Crossplane options used to generate