Skip to content

Commit 028606b

Browse files
Afsoonconnorshea
andcommitted
Apply suggestions from code review
Co-authored-by: Connor Shea <[email protected]> Signed-off-by: Said Atrahouch <[email protected]>
1 parent 0fbf691 commit 028606b

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

crates/oxc_linter/src/rules/vitest/warn_todo.rs

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,23 @@ use crate::{
1313
};
1414

1515
fn warn_todo_diagnostic(span: Span) -> OxcDiagnostic {
16-
// See <https://oxc.rs/docs/contribute/linter/adding-rules.html#diagnostics> for details
1716
OxcDiagnostic::warn("The use of `.todo` is not recommended.")
18-
.with_help("Remove the `.todo` modifier before push your changes.")
17+
.with_help("Write an actual test and remove the `.todo` modifier before pushing/merging your changes.")
1918
.with_label(span)
2019
}
2120

2221
#[derive(Debug, Default, Clone)]
2322
pub struct WarnTodo;
2423

25-
// See <https://github.com/oxc-project/oxc/issues/6050> for documentation details.
2624
declare_oxc_lint!(
2725
/// ### What it does
2826
///
29-
/// This rule should be used to trigger warnings when .todo is used in describe, it, or test functions.
30-
/// It is recommended to use this with GitHub Actions to annotate PR diffs.
27+
/// This rule triggers warnings when `.todo` is used in `describe`, `it`, or `test` functions.
28+
/// It is recommended to use this with your CI pipeline to annotate PR diffs.
3129
///
3230
/// ### Why is this bad?
3331
///
34-
/// The test that your push should be completed, any pending code should not be commit.
32+
/// The test that you push should be completed, any pending/"TODO" code should not be committed.
3533
///
3634
/// ### Examples
3735
///

0 commit comments

Comments
 (0)