docs(advisor): Say that the original provider is kept in merged results

Signed-off-by: Sebastian Schuberth <[email protected]>
oss-review-toolkit · Dec 5, 2024 · 6ebb731 · 6ebb731
1 parent d2ed373
commit 6ebb731
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/advisor/src/main/kotlin/Advisor.kt b/advisor/src/main/kotlin/Advisor.kt
@@ -98,6 +98,8 @@ class Advisor(
                         providerResults
                     }
                 }.forEach { providerResults ->
+                    // Merge results from different providers into a single map keyed by the package ID. The original
+                    // provider is still maintained as part of the AdvisorResult's AdvisorDetails.
                     providerResults.await().forEach { (pkg, advisorResults) ->
                         results.merge(pkg.id, listOf(advisorResults)) { existingResults, additionalResults ->
                             existingResults + additionalResults