internal: apply suggestions from code review

Co-authored-by: Eliott Bouhana <[email protected]>
DataDog · Jul 12, 2024 · 3d10986 · 3d10986
1 parent c3c01f3
commit 3d10986
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/internal/gitmetadata.go b/internal/gitmetadata.go
@@ -101,7 +101,7 @@ func getTagsFromBinary(readBuildInfo func() (*debug.BuildInfo, bool)) map[string
 	return res
 }
 
-// GetGitMetadataTags returns git metadata tags
+// GetGitMetadataTags returns git metadata tags. Returned map is read-only
 func GetGitMetadataTags() map[string]string {
 	initOnce.Do(initGitMetadataTags)
 	return gitMetadataTags
@@ -117,7 +117,7 @@ func initGitMetadataTags() {
 	}
 }
 
-// RefreshGitMetadataTags reset cached metadata tags
+// RefreshGitMetadataTags reset cached metadata tags. NOT thread-safe, use for testing only
 func RefreshGitMetadataTags() {
 	initGitMetadataTags()
 }