nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-23 15:23:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix formatting and lint description

Browse Source
This commit is contained in:
blyxyas 2023-04-04 11:42:32 +02:00
parent bd2a5b2322
commit b2f9191820
No known key found for this signature in database
GPG Key ID: 4D38170B5A2FC334
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
clippy_lints/src/tests_outside_test_module.rs
View File

@ -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]
@ -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]);