docs(RepositoryConfiguration): Improve documentation of two properties

Improve the documentation to better explain why both `curations` and `packageConfigurations` have nested `LicenseFindingCuration`s: Their scopes are different (project vs. package). Signed-off-by: Sebastian Schuberth <[email protected]>
oss-review-toolkit · Oct 31, 2023 · 35394a2 · 35394a2
1 parent 90f9993
commit 35394a2
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/model/src/main/kotlin/config/RepositoryConfiguration.kt b/model/src/main/kotlin/config/RepositoryConfiguration.kt
@@ -52,13 +52,14 @@ data class RepositoryConfiguration(
     val resolutions: Resolutions = Resolutions(),
 
     /**
-     * Defines curations for artifacts contained in this repository.
+     * Defines curations for packages used as dependencies by projects in this repository, or curations for license
+     * findings in the source code of a project in this repository.
      */
     @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = CurationsFilter::class)
     val curations: Curations = Curations(),
 
     /**
-     * Defines configurations for this repository.
+     * Defines configurations for packages used as dependencies by projects in this repository.
      */
     @JsonInclude(value = JsonInclude.Include.NON_EMPTY)
     val packageConfigurations: List<PackageConfiguration> = emptyList(),