[SERV-1275] Add example to godocs (#178)

Co-authored-by: Kevin S. Clarke <[email protected]>

Author: angelahuqing

validation/util/profile_doc_test.go

@@ -0,0 +1,30 @@
+package util
+
+import (
+	"encoding/json"
+	"fmt"
+)
+
+func ExampleProfiles() {
+	profiles := NewProfiles()
+
+	profile, err := NewProfile("example", []string{"Validation1", "Validation2"})
+	if err != nil {
+		panic(err)
+	}
+
+	if err := profiles.SetProfile(profile); err != nil {
+		panic(err)
+	}
+
+	// Print the profile name
+	fmt.Println(profiles.GetProfile("example").GetName())
+
+	// Print the snapshot JSON
+	snapshot := profiles.Snapshot()
+	jsonData, err := json.Marshal(snapshot)
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(string(jsonData))
+}

validation/util/profiles.go

@@ -1,25 +1,5 @@
 package util
 
-// This file contains utilities for creating and working with validation profiles.
-//
-// Example usage:
-//
-//	profiles := NewProfiles()
-//	if profile, err := NewProfile("example", []string{"Validation1", "Validation2"}); err != nil {
-//		require.NoError(t, err)
-//	} else {
-//		err = profiles.SetProfile(profile)
-//		require.NoError(t, err)
-//
-//		fmt.Println(profiles.GetProfile("example").GetName())
-//	}
-//
-//	snapshot := profiles.Snapshot()
-//	if jsonData, err := json.Marshal(snapshot); err != nil {
-//		require.NoError(t, err)
-//	} else {
-//		fmt.Println(string(jsonData))
-//	}
 import (
 	"encoding/json"
 	"fmt"