From 81561d19b372928d716ee9da735070807b1cca29 Mon Sep 17 00:00:00 2001 From: Sebastian Schuberth Date: Mon, 26 Aug 2024 10:02:09 +0200 Subject: [PATCH] docs: Avoid "our" in comments and use passive voice Signed-off-by: Sebastian Schuberth --- .../src/main/kotlin/ort-kotlin-conventions.gradle.kts | 4 ++-- model/src/main/kotlin/DependencyGraph.kt | 8 ++++---- model/src/main/kotlin/PackageReference.kt | 4 ++-- plugins/package-managers/node/src/main/kotlin/Npm.kt | 2 +- .../scancode/src/main/kotlin/ScanCodeResultModelMapper.kt | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/buildSrc/src/main/kotlin/ort-kotlin-conventions.gradle.kts b/buildSrc/src/main/kotlin/ort-kotlin-conventions.gradle.kts index b2d310011f184..c83e533579c98 100644 --- a/buildSrc/src/main/kotlin/ort-kotlin-conventions.gradle.kts +++ b/buildSrc/src/main/kotlin/ort-kotlin-conventions.gradle.kts @@ -83,10 +83,10 @@ kotlin.target.compilations.apply { configurations.all { resolutionStrategy { - // Ensure all JRuby versions match our version to avoid Psych YAML library issues. + // Ensure all transitive JRuby versions match ORT's version to avoid Psych YAML library issues. force(libs.jruby) - // Ensure that all transitive versions of Kotlin libraries match our version of Kotlin. + // Ensure that all transitive versions of Kotlin libraries match ORT's version of Kotlin. force("org.jetbrains.kotlin:kotlin-reflect:${libs.versions.kotlinPlugin.get()}") } } diff --git a/model/src/main/kotlin/DependencyGraph.kt b/model/src/main/kotlin/DependencyGraph.kt index 2eec2456ca542..3f51cbdc7a62d 100644 --- a/model/src/main/kotlin/DependencyGraph.kt +++ b/model/src/main/kotlin/DependencyGraph.kt @@ -322,9 +322,9 @@ class DependencyReference( val dependencies: Set = emptySet(), /** - * The type of linkage used for the referred package from its dependent package. As most of our supported + * The type of linkage used for the referred package from its dependent package. As most of ORT's supported * package managers / languages only support dynamic linking or at least default to it, also use that as the - * default value here to not blow up our result files. + * default value here to not blow up ORT result files. */ @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = PackageLinkageValueFilter::class) val linkage: PackageLinkage = PackageLinkage.DYNAMIC, @@ -367,9 +367,9 @@ data class DependencyGraphNode( val fragment: Int = 0, /** - * The type of linkage used for the referred package from its dependent package. As most of our supported + * The type of linkage used for the referred package from its dependent package. As most of ORT's supported * package managers / languages only support dynamic linking or at least default to it, also use that as the - * default value here to not blow up our result files. + * default value here to not blow up ORT result files. */ @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = PackageLinkageValueFilter::class) val linkage: PackageLinkage = PackageLinkage.DYNAMIC, diff --git a/model/src/main/kotlin/PackageReference.kt b/model/src/main/kotlin/PackageReference.kt index dda959db1c5c3..a064be37eebd0 100644 --- a/model/src/main/kotlin/PackageReference.kt +++ b/model/src/main/kotlin/PackageReference.kt @@ -41,9 +41,9 @@ data class PackageReference( override val id: Identifier, /** - * The type of linkage used for the referred package from its dependent package. As most of our supported + * The type of linkage used for the referred package from its dependent package. As most of ORT's supported * package managers / languages only support dynamic linking or at least default to it, also use that as the - * default value here to not blow up our result files. + * default value here to not blow up ORT result files. */ @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = PackageLinkageValueFilter::class) override val linkage: PackageLinkage = PackageLinkage.DYNAMIC, diff --git a/plugins/package-managers/node/src/main/kotlin/Npm.kt b/plugins/package-managers/node/src/main/kotlin/Npm.kt index b8977d4c9a589..2d88c1061e4f5 100644 --- a/plugins/package-managers/node/src/main/kotlin/Npm.kt +++ b/plugins/package-managers/node/src/main/kotlin/Npm.kt @@ -204,7 +204,7 @@ open class Npm( val scopeNames = setOfNotNull( // Optional dependencies are just like regular dependencies except that NPM ignores failures when // installing them (see https://docs.npmjs.com/files/package.json#optionaldependencies), i.e. they are - // not a separate scope in our semantics. + // not a separate scope in ORT semantics. buildDependencyGraphForScopes( project, workingDir, diff --git a/plugins/scanners/scancode/src/main/kotlin/ScanCodeResultModelMapper.kt b/plugins/scanners/scancode/src/main/kotlin/ScanCodeResultModelMapper.kt index 1ef53c24d8bf5..5437c4b17425b 100644 --- a/plugins/scanners/scancode/src/main/kotlin/ScanCodeResultModelMapper.kt +++ b/plugins/scanners/scancode/src/main/kotlin/ScanCodeResultModelMapper.kt @@ -40,7 +40,7 @@ const val MAX_SUPPORTED_OUTPUT_FORMAT_MAJOR_VERSION = 3 private val TIMESTAMP_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HHmmss.n").withZone(ZoneId.of("UTC")) -// Note: The "(File: ...)" part in the patterns below is actually added by our own getRawResult() function. +// Note: The "(File: ...)" part in the patterns below is actually added by ORT's own getRawResult() function. private val UNKNOWN_ERROR_REGEX = Regex( "(ERROR: for scanner: (?\\w+):\n)?" + "ERROR: Unknown error:\n.+\n(?\\w+Error)[:\n](?.*) \\(File: (?.+)\\)",