add doc comment on the Templated field

options.go

@@ -4,10 +4,15 @@ import "net/http"
 
 // LinkInfo represents a link to a resource.
 type LinkInfo struct {
-	Method    string `json:"method"`
-	Href      string `json:"href"`
-	Comment   string `json:"comment"`
-	Templated bool   `json:"templated,omitempty"`
+	Method  string `json:"method"`
+	Href    string `json:"href"`
+	Comment string `json:"comment"`
+	// Templated marks the link as a template, so the client can identify a link
+	// as a template and they don't try to call the endpoint as it is presented.
+	//
+	// This field is defined in the draft RFC in section 5.2:
+	// https://datatracker.ietf.org/doc/html/draft-kelly-json-hal#section-5.2
+	Templated bool `json:"templated,omitempty"`
 }
 
 // LinkOption is used to register links in a LinkRegistry. Urls may contain