Skip to content

Commit

Permalink
Fix formatting and lint description
Browse files Browse the repository at this point in the history
  • Loading branch information
blyxyas committed Apr 4, 2023
1 parent bd2a5b2 commit b2f9191
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions clippy_lints/src/tests_outside_test_module.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@ use rustc_span::{def_id::LocalDefId, Span};

declare_clippy_lint! {
/// ### What it does
///
/// Triggers when a testing function (marked with the `#[test]` attribute) isn't inside a testing module (marked with `#[cfg(test)]`).
///
/// Triggers when a testing function (marked with the `#[test]` attribute) isn't inside a testing module
/// (marked with `#[cfg(test)]`).
/// ### Why is this bad?
///
/// The idiomatic (and more performant) way of writing tests is inside a testing module (flagged with `#[cfg(test)]`), having test functions outside of this module is confusing and may lead to them being "hidden".
///
/// The idiomatic (and more performant) way of writing tests is inside a testing module (flagged with `#[cfg(test)]`),
/// having test functions outside of this module is confusing and may lead to them being "hidden".
/// ### Example
/// ```rust
/// #[test]
Expand All @@ -39,7 +37,7 @@ declare_clippy_lint! {
#[clippy::version = "1.70.0"]
pub TESTS_OUTSIDE_TEST_MODULE,
restriction,
"The test function `my_cool_test` is outside the testing module `tests`."
"A test function is outside the testing module."
}

declare_lint_pass!(TestsOutsideTestModule => [TESTS_OUTSIDE_TEST_MODULE]);
Expand Down

0 comments on commit b2f9191

Please sign in to comment.