internal/govulncheck: update description of Findings

Change-Id: I699ea906e227b3fafd029adbd7ad8d31e53e2943 Reviewed-on: https://go-review.googlesource.com/c/vuln/+/522156 Run-TryBot: Zvonimir Pavlinovic <[email protected]> TryBot-Result: Gopher Robot <[email protected]> Reviewed-by: Maceo Thompson <[email protected]>
golang · Sep 20, 2023 · 87ceb80 · 87ceb80
1 parent 712bbae
commit 87ceb80
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/internal/govulncheck/govulncheck.go b/internal/govulncheck/govulncheck.go
@@ -69,7 +69,10 @@ type Progress struct {
 	Message string `json:"message,omitempty"`
 }
 
-// Vuln represents a single OSV entry.
+// Finding contains information on a discovered vulnerability. The same vulnerability
+// can have multiple findings. This can happen when, say, multiple symbols of the
+// same vulnerability are called or govulncheck decides to show multiple traces for
+// the same symbol.
 type Finding struct {
 	// OSV is the id of the detected vulnerability.
 	OSV string `json:"osv,omitempty"`