Skip to content

Commit dc86b7f

Browse files
committed
docs(advisors): Clarify to only return packages with findings
Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
1 parent 6767d44 commit dc86b7f

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

plugins/advisors/api/src/main/kotlin/AdviceProvider.kt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ import org.ossreviewtoolkit.plugins.api.Plugin
3030
*/
3131
interface AdviceProvider : Plugin {
3232
/**
33-
* For a given set of [Package]s, retrieve findings and return a map that associates packages with [AdvisorResult]s.
33+
* For a given set of [packages], retrieve findings and return a map of only those packages that actually have
34+
* findings associated with an [AdvisorResult].
3435
*/
3536
suspend fun retrievePackageFindings(packages: Set<Package>): Map<Package, AdvisorResult>
3637

0 commit comments

Comments
 (0)