]> git.lizzy.rs Git - rust.git/commitdiff
Configurations: document report_todo and report_fixme
authorBen Boeckel <ben.boeckel@kitware.com>
Thu, 9 Nov 2017 19:10:37 +0000 (14:10 -0500)
committerBen Boeckel <ben.boeckel@kitware.com>
Thu, 9 Nov 2017 19:11:33 +0000 (14:11 -0500)
Configurations.md

index f504b8e74688ace8341371a73f801da751b7d0aa..68ff64cffb9b41ba7be82fd7a403c2a69773047d 100644 (file)
@@ -1614,6 +1614,32 @@ extern crate sit;
 
 See also [`reorder_extern_crates`](#reorder_extern_crates).
 
+## `report_todo`
+
+Report `TODO` items in comments.
+
+- **Default value**: `"Never"`
+- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
+
+Warns about any comments containing `TODO` in them when set to `"Always"`. If
+it contains a `#X` (with `X` being a number) in parentheses following the
+`TODO`, `"Unnumbered"` will ignore it.
+
+See also [`report_fixme`](#report_fixme).
+
+## `report_fixme`
+
+Report `FIXME` items in comments.
+
+- **Default value**: `"Never"`
+- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
+
+Warns about any comments containing `FIXME` in them when set to `"Always"`. If
+it contains a `#X` (with `X` being a number) in parentheses following the
+`FIXME`, `"Unnumbered"` will ignore it.
+
+See also [`report_todo`](#report_todo).
+
 ## `single_line_if_else_max_width`
 
 Maximum line length for single line if-else expressions.