Skip to content

Commit 0b01b87

Browse files
committed
docs(license-fact-providers): Reword summaries
Make summaries more concise as full descriptions are now being generated from the class docs. Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.io>
1 parent ef6b699 commit 0b01b87

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

plugins/license-fact-providers/dir/src/main/kotlin/CustomLicenseTextsProvider.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ data class CustomLicenseTextsProviderConfig(
4545
*/
4646
@OrtPlugin(
4747
displayName = "Default Custom License Texts Provider",
48-
summary = "A license fact provider that reads license texts from the default custom license texts directory.",
48+
summary = "Provide license texts from the default custom license texts directory.",
4949
factory = LicenseFactProviderFactory::class
5050
)
5151
class DefaultCustomLicenseTextsProvider(
@@ -64,7 +64,7 @@ class DefaultCustomLicenseTextsProvider(
6464
@OrtPlugin(
6565
id = "CustomLicenseTexts",
6666
displayName = "Custom License Texts Provider",
67-
summary = "A license fact provider that reads license texts from a local directory.",
67+
summary = "Provide license texts from a custom directory.",
6868
factory = LicenseFactProviderFactory::class
6969
)
7070
open class CustomLicenseTextsProvider(

plugins/license-fact-providers/dir/src/main/kotlin/LicenseTextCurationProvider.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ data class LicenseTextCurationProviderConfig(
5252
*/
5353
@OrtPlugin(
5454
displayName = "Default License Text Curation Provider",
55-
summary = "A license fact provider that reads license information from the default directory.",
55+
summary = "Provide project- and / or package-specific license texts from the default directory.",
5656
factory = LicenseFactProviderFactory::class
5757
)
5858
class DefaultLicenseTextCurationProvider(
@@ -71,7 +71,7 @@ class DefaultLicenseTextCurationProvider(
7171
@OrtPlugin(
7272
id = "LicenseTextCurationProvider",
7373
displayName = "License Text Curation Provider",
74-
summary = "A license fact provider that reads license text curations from a local directory.",
74+
summary = "Provide project- and / or package-specific license texts from a custom directory.",
7575
factory = LicenseFactProviderFactory::class
7676
)
7777
open class LicenseTextCurationProvider(

plugins/license-fact-providers/scancode/src/main/kotlin/ScanCodeLicenseFactProvider.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ data class ScanCodeLicenseFactProviderConfig(
5252
@OrtPlugin(
5353
id = "ScanCode",
5454
displayName = "ScanCode License Fact Provider",
55-
summary = "A license fact provider that reads license information from a local ScanCode installation.",
55+
summary = "Provide license facts from a local ScanCode installation.",
5656
factory = LicenseFactProviderFactory::class
5757
)
5858
class ScanCodeLicenseFactProvider(

plugins/license-fact-providers/spdx/src/main/kotlin/SpdxLicenseFactProvider.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import org.ossreviewtoolkit.plugins.licensefactproviders.api.LicenseText
3030
@OrtPlugin(
3131
id = "SPDX",
3232
displayName = "SPDX License Fact Provider",
33-
summary = "A provider for SPDX license facts.",
33+
summary = "Provide license facts from ORT's built-in SPDX resources.",
3434
factory = LicenseFactProviderFactory::class
3535
)
3636
class SpdxLicenseFactProvider(

0 commit comments

Comments
 (0)