docs(terraform): More documentation edits.

Author: skyzyx

.golangci.yml

@@ -841,6 +841,11 @@ issues:
         - tagliatelle
       source: lint:allow_format
 
+    - text: (is unused)
+      linters:
+        - unused
+      source: lint:allow_unused
+
   # Independently from option `exclude` we use default exclude patterns, it can be disabled by this
   # option. To list all excluded by default patterns execute `golangci-lint run --help`. Default
   # value for this option is true.

corefunc/test_helpers.go

@@ -6,9 +6,17 @@ import (
 	"strings"
 )
 
-func traceFuncName() string {
-	pc := make([]uintptr, 15)
-	n := runtime.Callers(2, pc)
+const (
+	// Terratest displays a Markdown link to Terratest.
+	Terratest = "[Terratest](https://terratest.gruntwork.io)"
+
+	// TPF displays a Markdown link to the Terraform Plugin Framework.
+	TPF = "[Terraform Plugin Framework](https://developer.hashicorp.com/terraform/plugin/framework)"
+)
+
+func traceFuncName() string { // lint:allow_unused
+	pc := make([]uintptr, 15)   // lint:allow_raw_number
+	n := runtime.Callers(2, pc) // lint:allow_raw_number
 	frames := runtime.CallersFrames(pc[:n])
 	frame, _ := frames.Next()
 
@@ -20,3 +28,11 @@ func traceFuncName() string {
 		),
 	)
 }
+
+func linkPackage(functionName string) string {
+	return "[`corefunc." +
+		functionName +
+		"()`](https://pkg.go.dev/github.com/northwood-labs/terraform-provider-corefunc/corefunc#" +
+		functionName +
+		")"
+}

corefunc/truncate_label_data_source.go

@@ -41,7 +41,8 @@ type (
 	}
 )
 
-// TruncateLabelDataSource is a helper function to simplify the provider implementation.
+// TruncateLabelDataSource is a method that exposes its paired Go function as a
+// Terraform Data Source.
 func TruncateLabelDataSource() datasource.DataSource { // lint:allow_return_interface
 	return &truncateLabelDataSource{}
 }
@@ -72,26 +73,28 @@ func (d *truncateLabelDataSource) Schema(
 
 	resp.Schema = schema.Schema{
 		MarkdownDescription: strings.TrimSpace(dedent.Dedent(`
-        TruncateLabel supports prepending a prefix to a label, while truncating them
+        Supports prepending a prefix to a label, while truncating them
         to meet the maximum length constraints. Useful when grouping labels with a
         kind of prefix. Both the prefix and the label will be truncated if necessary.
 
-        Uses a "balancing" algorithm between the prefix and the label, so that each
+        Uses a “balancing” algorithm between the prefix and the label, so that each
         section is truncated as a factor of how much space it takes up in the merged
         string.
 
         -> The motivation for this is in working with monitoring systems such
         as New Relic and Datadog where there are hundreds of applications in a
-        monitoring "prod" account, and also hundreds of applications in a monitoring
-        "nonprod" account. This allows us to group lists of monitors together using a
+        monitoring “prod” account, and also hundreds of applications in a monitoring
+        “nonprod” account. This allows us to group lists of monitors together using a
         shared prefix, but also truncate them appropriately to fit length
         constraints for names.
+
+        Maps to the ` + linkPackage("TruncateLabel") + ` Go method, which can be used in
+        ` + Terratest + `.
         `)),
 		Attributes: map[string]schema.Attribute{
 			"id": schema.Int64Attribute{
-				Description: "Not used. Required by the " +
-					"[Terraform Plugin Framework](https://developer.hashicorp.com/terraform/plugin/framework).",
-				Computed: true,
+				Description: "Not used. Required by the " + TPF + ".",
+				Computed:    true,
 			},
 			"max_length": schema.Int64Attribute{
 				Description: "The maximum allowed length of the combined label. " +

docs/data-sources/str_truncate_label.md

@@ -3,38 +3,43 @@
 page_title: "corefunc_str_truncate_label Data Source - corefunc"
 subcategory: ""
 description: |-
-  TruncateLabel supports prepending a prefix to a label, while truncating them
+  Supports prepending a prefix to a label, while truncating them
   to meet the maximum length constraints. Useful when grouping labels with a
   kind of prefix. Both the prefix and the label will be truncated if necessary.
-  Uses a "balancing" algorithm between the prefix and the label, so that each
+  Uses a “balancing” algorithm between the prefix and the label, so that each
   section is truncated as a factor of how much space it takes up in the merged
   string.
   -> The motivation for this is in working with monitoring systems such
   as New Relic and Datadog where there are hundreds of applications in a
-  monitoring "prod" account, and also hundreds of applications in a monitoring
-  "nonprod" account. This allows us to group lists of monitors together using a
+  monitoring “prod” account, and also hundreds of applications in a monitoring
+  “nonprod” account. This allows us to group lists of monitors together using a
   shared prefix, but also truncate them appropriately to fit length
   constraints for names.
+  Maps to the corefunc.TruncateLabel() https://pkg.go.dev/github.com/northwood-labs/terraform-provider-corefunc/corefunc#TruncateLabel Go method, which can be used in
+  Terratest https://terratest.gruntwork.io.
 ---
 -->
 
 # corefunc_str_truncate_label (Data Source)
 
-TruncateLabel supports prepending a prefix to a label, while truncating them
+Supports prepending a prefix to a label, while truncating them
 to meet the maximum length constraints. Useful when grouping labels with a
 kind of prefix. Both the prefix and the label will be truncated if necessary.
 
-Uses a "balancing" algorithm between the prefix and the label, so that each
+Uses a “balancing” algorithm between the prefix and the label, so that each
 section is truncated as a factor of how much space it takes up in the merged
 string.
 
 -> The motivation for this is in working with monitoring systems such
 as New Relic and Datadog where there are hundreds of applications in a
-monitoring "prod" account, and also hundreds of applications in a monitoring
-"nonprod" account. This allows us to group lists of monitors together using a
+monitoring “prod” account, and also hundreds of applications in a monitoring
+“nonprod” account. This allows us to group lists of monitors together using a
 shared prefix, but also truncate them appropriately to fit length
 constraints for names.
 
+Maps to the [`corefunc.TruncateLabel()`](https://pkg.go.dev/github.com/northwood-labs/terraform-provider-corefunc/corefunc#TruncateLabel) Go method, which can be used in
+[Terratest](https://terratest.gruntwork.io).
+
 ## Example Usage
 
 ```terraform

main.go

@@ -1,3 +1,7 @@
+/*
+`main.go` is the entrypoint of the Terraform provider. See
+[`corefunc`](./corefunc) for the Go library code.
+*/
 package main
 
 import (