internal/govulncheck: update description of Findings
Change-Id: I699ea906e227b3fafd029adbd7ad8d31e53e2943
Reviewed-on: https://go-review.googlesource.com/c/vuln/+/522156
Run-TryBot: Zvonimir Pavlinovic <zpavlinovic@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Maceo Thompson <maceothompson@google.com>
diff --git a/internal/govulncheck/govulncheck.go b/internal/govulncheck/govulncheck.go
index 3456936..d10a127 100644
--- a/internal/govulncheck/govulncheck.go
+++ b/internal/govulncheck/govulncheck.go
@@ -69,7 +69,10 @@
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"`
