Skip to content

Commit 81561d1

Browse files
committed
docs: Avoid "our" in comments and use passive voice
Signed-off-by: Sebastian Schuberth <[email protected]>
1 parent eaba79c commit 81561d1

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

buildSrc/src/main/kotlin/ort-kotlin-conventions.gradle.kts

+2-2
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ kotlin.target.compilations.apply {
8383

8484
configurations.all {
8585
resolutionStrategy {
86-
// Ensure all JRuby versions match our version to avoid Psych YAML library issues.
86+
// Ensure all transitive JRuby versions match ORT's version to avoid Psych YAML library issues.
8787
force(libs.jruby)
8888

89-
// Ensure that all transitive versions of Kotlin libraries match our version of Kotlin.
89+
// Ensure that all transitive versions of Kotlin libraries match ORT's version of Kotlin.
9090
force("org.jetbrains.kotlin:kotlin-reflect:${libs.versions.kotlinPlugin.get()}")
9191
}
9292
}

model/src/main/kotlin/DependencyGraph.kt

+4-4
Original file line numberDiff line numberDiff line change
@@ -322,9 +322,9 @@ class DependencyReference(
322322
val dependencies: Set<DependencyReference> = emptySet(),
323323

324324
/**
325-
* The type of linkage used for the referred package from its dependent package. As most of our supported
325+
* The type of linkage used for the referred package from its dependent package. As most of ORT's supported
326326
* package managers / languages only support dynamic linking or at least default to it, also use that as the
327-
* default value here to not blow up our result files.
327+
* default value here to not blow up ORT result files.
328328
*/
329329
@JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = PackageLinkageValueFilter::class)
330330
val linkage: PackageLinkage = PackageLinkage.DYNAMIC,
@@ -367,9 +367,9 @@ data class DependencyGraphNode(
367367
val fragment: Int = 0,
368368

369369
/**
370-
* The type of linkage used for the referred package from its dependent package. As most of our supported
370+
* The type of linkage used for the referred package from its dependent package. As most of ORT's supported
371371
* package managers / languages only support dynamic linking or at least default to it, also use that as the
372-
* default value here to not blow up our result files.
372+
* default value here to not blow up ORT result files.
373373
*/
374374
@JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = PackageLinkageValueFilter::class)
375375
val linkage: PackageLinkage = PackageLinkage.DYNAMIC,

model/src/main/kotlin/PackageReference.kt

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ data class PackageReference(
4141
override val id: Identifier,
4242

4343
/**
44-
* The type of linkage used for the referred package from its dependent package. As most of our supported
44+
* The type of linkage used for the referred package from its dependent package. As most of ORT's supported
4545
* package managers / languages only support dynamic linking or at least default to it, also use that as the
46-
* default value here to not blow up our result files.
46+
* default value here to not blow up ORT result files.
4747
*/
4848
@JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = PackageLinkageValueFilter::class)
4949
override val linkage: PackageLinkage = PackageLinkage.DYNAMIC,

plugins/package-managers/node/src/main/kotlin/Npm.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ open class Npm(
204204
val scopeNames = setOfNotNull(
205205
// Optional dependencies are just like regular dependencies except that NPM ignores failures when
206206
// installing them (see https://docs.npmjs.com/files/package.json#optionaldependencies), i.e. they are
207-
// not a separate scope in our semantics.
207+
// not a separate scope in ORT semantics.
208208
buildDependencyGraphForScopes(
209209
project,
210210
workingDir,

plugins/scanners/scancode/src/main/kotlin/ScanCodeResultModelMapper.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ const val MAX_SUPPORTED_OUTPUT_FORMAT_MAJOR_VERSION = 3
4040

4141
private val TIMESTAMP_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HHmmss.n").withZone(ZoneId.of("UTC"))
4242

43-
// Note: The "(File: ...)" part in the patterns below is actually added by our own getRawResult() function.
43+
// Note: The "(File: ...)" part in the patterns below is actually added by ORT's own getRawResult() function.
4444
private val UNKNOWN_ERROR_REGEX = Regex(
4545
"(ERROR: for scanner: (?<scanner>\\w+):\n)?" +
4646
"ERROR: Unknown error:\n.+\n(?<error>\\w+Error)[:\n](?<message>.*) \\(File: (?<file>.+)\\)",

0 commit comments

Comments
 (0)