Skip to content

Commit

Permalink
docs: Avoid "our" in comments and use passive voice
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastian Schuberth <[email protected]>
  • Loading branch information
sschuberth committed Sep 11, 2024
1 parent eaba79c commit 81561d1
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions buildSrc/src/main/kotlin/ort-kotlin-conventions.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -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()}")
}
}
Expand Down
8 changes: 4 additions & 4 deletions model/src/main/kotlin/DependencyGraph.kt
Original file line number Diff line number Diff line change
Expand Up @@ -322,9 +322,9 @@ class DependencyReference(
val dependencies: Set<DependencyReference> = 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,
Expand Down Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions model/src/main/kotlin/PackageReference.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion plugins/package-managers/node/src/main/kotlin/Npm.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: (?<scanner>\\w+):\n)?" +
"ERROR: Unknown error:\n.+\n(?<error>\\w+Error)[:\n](?<message>.*) \\(File: (?<file>.+)\\)",
Expand Down

0 comments on commit 81561d1

Please sign in to comment.