Skip to content

Commit 17aaf48

Browse files
author
yevhenii.nadtochii
committed
Don't use too wide code term
1 parent 77c8585 commit 17aaf48

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

buildSrc/settings.gradle.kts

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ buildscript {
3333
}
3434
dependencies {
3535
// We don't apply any plugins.
36-
// We just put our code on a classpath of settings script.
36+
// We just put `SpineVersionCatalog` class on a classpath of settings script.
3737
classpath("io.spine.internal:spine-version-catalog:+")
3838
}
3939
}
@@ -42,13 +42,14 @@ dependencyResolutionManagement {
4242
versionCatalogs {
4343

4444
/*
45-
The code, we have put on a classpath, exposes a class `SpineVersionCatalog`,
46-
which can execute actions upon `VersionCatalogBuilder`.
45+
`SpineVersionCatalog` is not a plugin, it just exposes a method, which
46+
operates upon Gradle's provided `VersionCatalogBuilder`, filling it up
47+
with items.
4748
4849
It is so because we want to preserve a possibility of overwrite.
4950
Currently, Gradle does not provide a clear way to perform overwrite for
50-
already created catalogs. Thus, it is a responsibility of end-users
51-
to create catalogs. `SpineVersionCatalog` just operates upon the given builder.
51+
ALREADY CREATED catalogs. Thus, a plugin can't create the catalog, and
52+
it's a responsibility of end-users to it.
5253
5354
In order to override a version, shipped by the catalog, one should
5455
declare it BEFORE applying the catalog to the builder. Versions,
@@ -80,7 +81,7 @@ dependencyResolutionManagement {
8081
version("kotlin", "1.5.31")
8182
version("kotlinX-coroutines", "1.5.2")
8283

83-
// Fills up this catalog with our dependencies.
84+
// Fills up this builder.
8485
SpineVersionCatalog.useIn(this)
8586
}
8687
}

settings.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ buildscript {
4747
}
4848
dependencies {
4949
// We don't apply any plugins.
50-
// We just put our code on a classpath of settings script.
50+
// We just put `SpineVersionCatalog` class on a classpath of settings script.
5151
classpath("io.spine.internal:spine-version-catalog:+")
5252
}
5353
}

0 commit comments

Comments
 (0)