From 83308a1c184982c96a3a955829b524ec8fb1471a Mon Sep 17 00:00:00 2001 From: Sebastian Schuberth Date: Fri, 29 Dec 2023 17:27:33 +0100 Subject: [PATCH] docs(scanner): Generally write "scanner-specific" with a dash This addresses a grammar hint. Signed-off-by: Sebastian Schuberth --- model/src/main/kotlin/ScanResult.kt | 2 +- model/src/main/kotlin/Snippet.kt | 4 ++-- model/src/main/kotlin/config/ScannerConfiguration.kt | 2 +- scanner/src/main/kotlin/ScannerWrapper.kt | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/model/src/main/kotlin/ScanResult.kt b/model/src/main/kotlin/ScanResult.kt index cd10d71f21013..e4cc4ddba202c 100644 --- a/model/src/main/kotlin/ScanResult.kt +++ b/model/src/main/kotlin/ScanResult.kt @@ -43,7 +43,7 @@ data class ScanResult( val summary: ScanSummary, /** - * A map for scanner specific data that cannot be mapped into any generalized property, but still needs to be + * A map for scanner-specific data that cannot be mapped into any generalized property, but still needs to be * stored in the scan result. */ @JsonInclude(JsonInclude.Include.NON_EMPTY) diff --git a/model/src/main/kotlin/Snippet.kt b/model/src/main/kotlin/Snippet.kt index ca190197b063e..2ecd44efa7637 100644 --- a/model/src/main/kotlin/Snippet.kt +++ b/model/src/main/kotlin/Snippet.kt @@ -25,7 +25,7 @@ import org.ossreviewtoolkit.utils.spdx.SpdxExpression data class Snippet( /** - * The matching score between the code being scanned and the code snippet. This is scanner specific (e.g. for + * The matching score between the code being scanned and the code snippet. This is scanner-specific (e.g. for * ScanOSS this is a percentage). */ val score: Float, @@ -52,7 +52,7 @@ data class Snippet( val licenses: SpdxExpression, /** - * A map for scanner specific snippet data that cannot be mapped into any generalized property, but still needs to + * A map for scanner-specific snippet data that cannot be mapped into any generalized property, but still needs to * be made available in the scan summary. */ @JsonInclude(JsonInclude.Include.NON_EMPTY) diff --git a/model/src/main/kotlin/config/ScannerConfiguration.kt b/model/src/main/kotlin/config/ScannerConfiguration.kt index 8a8b10a034ae5..4c6295538cf9a 100644 --- a/model/src/main/kotlin/config/ScannerConfiguration.kt +++ b/model/src/main/kotlin/config/ScannerConfiguration.kt @@ -88,7 +88,7 @@ data class ScannerConfiguration( val fileListStorage: FileListStorageConfiguration? = null, /** - * Scanner specific configuration options. The key needs to match the name of the scanner class, e.g. "ScanCode" + * Scanner-specific configuration options. The key needs to match the name of the scanner class, e.g. "ScanCode" * for the ScanCode wrapper. See the documentation of the scanner for available options. */ @JsonAlias("options") diff --git a/scanner/src/main/kotlin/ScannerWrapper.kt b/scanner/src/main/kotlin/ScannerWrapper.kt index 9a1586993d259..83dcb83c7f373 100644 --- a/scanner/src/main/kotlin/ScannerWrapper.kt +++ b/scanner/src/main/kotlin/ScannerWrapper.kt @@ -58,7 +58,7 @@ sealed interface ScannerWrapper { /** * The [ScannerMatcher] object to be used when looking up existing scan results from a scan storage. By default, * the properties of this object are initialized by the scanner implementation. These defaults can be overridden - * with the scanner specific [options][PluginConfiguration.options] in [ScannerConfiguration.config]: Use properties + * with the scanner-specific [options][PluginConfiguration.options] in [ScannerConfiguration.config]: Use properties * of the form `scannerName.options.property`, where `scannerName` is the name of the scanner and `property` is the * name of a property of the [ScannerMatcher] class. For instance, to specify that a specific minimum version of * ScanCode is allowed, set this property: `config.ScanCode.options.minVersion=3.0.2`.