Skip to content

Commit

Permalink
docs(scanner): Generally write "scanner-specific" with a dash
Browse files Browse the repository at this point in the history
This addresses a grammar hint.

Signed-off-by: Sebastian Schuberth <[email protected]>
  • Loading branch information
sschuberth committed Dec 29, 2023
1 parent 98b4026 commit 83308a1
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion model/src/main/kotlin/ScanResult.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions model/src/main/kotlin/Snippet.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion model/src/main/kotlin/config/ScannerConfiguration.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
2 changes: 1 addition & 1 deletion scanner/src/main/kotlin/ScannerWrapper.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit 83308a1

Please sign in to comment.