Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Formulate rule/coroutines descriptions consistently #4415

Merged
merged 1 commit into from Dec 28, 2021
Merged

Formulate rule/coroutines descriptions consistently #4415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...ines/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/coroutines/GlobalCoroutineUsage.kt
View file
Open in desktop
Expand Up @@ -43,7 +43,7 @@ class GlobalCoroutineUsage(config: Config = Config.empty) : Rule(config) {
override val issue = Issue(
javaClass.simpleName,
Severity.Defect,
"Usage of GlobalScope instance is highly discouraged",
"The usage of the `GlobalScope` instance is highly discouraged.",
Debt.TEN_MINS
)

Expand Down
2 changes: 1 addition & 1 deletion .../src/main/kotlin/io/gitlab/arturbosch/detekt/rules/coroutines/RedundantSuspendModifier.kt
View file
Open in desktop
Expand Up @@ -59,7 +59,7 @@ class RedundantSuspendModifier(config: Config) : Rule(config) {
override val issue = Issue(
"RedundantSuspendModifier",
Severity.Minor,
"`suspend` modifier is only needed for functions that contain suspending calls",
"The `suspend` modifier is only needed for functions that contain suspending calls.",
Debt.FIVE_MINS
)

Expand Down
2 changes: 1 addition & 1 deletion ...tines/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/coroutines/SleepInsteadOfDelay.kt
View file
Open in desktop
Expand Up @@ -43,7 +43,7 @@ class SleepInsteadOfDelay(config: Config = Config.empty) : Rule(config) {
override val issue = Issue(
javaClass.simpleName,
Severity.Defect,
"Usage of Thread.sleep() in coroutines can potentially halt multiple coroutines at once.",
"Usage of `Thread.sleep()` in coroutines can potentially halt multiple coroutines at once.",
Debt.FIVE_MINS
)

Expand Down
2 changes: 1 addition & 1 deletion .../main/kotlin/io/gitlab/arturbosch/detekt/rules/coroutines/SuspendFunWithFlowReturnType.kt
View file
Open in desktop
Expand Up @@ -64,7 +64,7 @@ class SuspendFunWithFlowReturnType(config: Config) : Rule(config) {
override val issue = Issue(
id = "SuspendFunWithFlowReturnType",
severity = Severity.Minor,
description = "`suspend` modifier should not be used for functions that return a " +
description = "The `suspend` modifier should not be used for functions that return a " +
"Coroutines Flow type. Flows are cold streams and invoking a function that returns " +
"one should not produce any side effects.",
debt = Debt.TEN_MINS
Expand Down