Auto merge of #7873 - xFrednet:7869-string-index-ice, r=Manishearth

[rust.git] / doc / adding_lints.md

diff --git a/doc/adding_lints.md b/doc/adding_lints.md
index 004eb28b44640fb59ab3d43c31203ab97c622870..e0a9b27777aa47b4bb27c3580c25e0a7124c3b66 100644 (file)
--- a/doc/adding_lints.md
+++ b/doc/adding_lints.md
@@ -564,7 +564,8 @@ in the following steps:
     /// <The configuration field doc comment>
     (configuration_ident: Type = DefaultValue),
     ```
-    The doc comment will be automatically added to the lint documentation.
+    The doc comment is automatically added to the documentation of the listed lints. The default
+    value will be formatted using the `Debug` implementation of the type.
 2. Adding the configuration value to the lint impl struct:
     1. This first requires the definition of a lint impl struct. Lint impl structs are usually
         generated with the `declare_lint_pass!` macro. This struct needs to be defined manually