Skip to content

Commit a39a252

Browse files
committed
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]>
1 parent fe08372 commit a39a252

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

model/src/main/kotlin/config/RepositoryConfiguration.kt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,14 @@ data class RepositoryConfiguration(
5252
val resolutions: Resolutions = Resolutions(),
5353

5454
/**
55-
* Defines curations for artifacts contained in this repository.
55+
* Defines curations for packages used as dependencies by projects in this repository, or curations for license
56+
* findings in the source code of a project in this repository.
5657
*/
5758
@JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = CurationsFilter::class)
5859
val curations: Curations = Curations(),
5960

6061
/**
61-
* Defines configurations for this repository.
62+
* Defines configurations for packages used as dependencies by projects in this repository.
6263
*/
6364
@JsonInclude(value = JsonInclude.Include.NON_EMPTY)
6465
val packageConfigurations: List<PackageConfiguration> = emptyList(),

0 commit comments

Comments
 (0)