Add a ignore-tidy-todo to ignore the tidy TODO comment check

rust-lang · Jun 12, 2024 · 39c3b86 · 39c3b86
1 parent bbe9a9c
commit 39c3b86
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/tools/tidy/src/style.rs b/src/tools/tidy/src/style.rs
@@ -444,7 +444,9 @@ pub fn check(path: &Path, bad: &mut bool) {
                 suppressible_tidy_err!(err, skip_cr, "CR character");
             }
             if filename != "style.rs" {
-                if trimmed.contains("TODO") {
+                // Allow using TODO in diagnostic suggestions by marking the
+                // relevant line with `// ignore-tidy-todo`.
+                if trimmed.contains("TODO") && !trimmed.contains("ignore-tidy-todo") {
                     err(
                         "TODO is used for tasks that should be done before merging a PR; If you want to leave a message in the codebase use FIXME",
                     )