Merge pull request #1223 from hashicorp/td-comments-on-generated-regions

Comments on generated Regions and partitions
hashicorp · Dec 2, 2024 · bcfc476 · bcfc476
2 parents 3cb4211 + bdc3757
commit bcfc476
Show file tree

Hide file tree

Showing 3 changed files with 111 additions and 48 deletions.
diff --git a/endpoints/endpoints.go b/endpoints/endpoints.go
@@ -4,5 +4,6 @@
 package endpoints
 
 const (
-	AwsGlobalRegionID = "aws-global" // AWS Standard global region.
+	// AWS Standard global region.
+	AwsGlobalRegionID = "aws-global"
 )
diff --git a/endpoints/endpoints_gen.go b/endpoints/endpoints_gen.go
diff --git a/internal/generate/endpoints/output.go.gtpl b/internal/generate/endpoints/output.go.gtpl
@@ -12,7 +12,8 @@ import (
 // All known partition IDs.
 const (
 {{- range .Partitions }}
-    {{ .ID | IDToTitle}}PartitionID = "{{ .ID }}" // {{ .Name }}
+    // {{ .Name }}
+    {{ .ID | IDToTitle}}PartitionID = "{{ .ID }}"
 {{- end }}
 )
 
@@ -21,7 +22,8 @@ const (
 {{- range .Partitions }}
     // {{ .Name }} partition's Regions.
     {{- range .Regions }}
-    {{ .ID | IDToTitle}}RegionID = "{{ .ID }}" // {{ .Description }}
+    // {{ .Description }}
+    {{ .ID | IDToTitle}}RegionID = "{{ .ID }}"
     {{- end }}
 {{- end }}
 )