diff options
| author | Takayuki Nakata <f.seasons017@gmail.com> | 2020-08-13 09:02:49 +0900 |
|---|---|---|
| committer | Takayuki Nakata <f.seasons017@gmail.com> | 2020-08-13 09:02:49 +0900 |
| commit | 9f827abeb0ad8f4e3ed37af462907a31be7f7cdb (patch) | |
| tree | 23e9c03c3a69c8cd3457ea12984253c10388ca32 | |
| parent | 3337f7956cf6100c9e5acfd72d42ec312efb6a7f (diff) | |
| download | rust-9f827abeb0ad8f4e3ed37af462907a31be7f7cdb.tar.gz rust-9f827abeb0ad8f4e3ed37af462907a31be7f7cdb.zip | |
Add reference to rustc-dev-guide about lint message
| -rw-r--r-- | doc/adding_lints.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/adding_lints.md b/doc/adding_lints.md index 168092f7329..3c782e9b17f 100644 --- a/doc/adding_lints.md +++ b/doc/adding_lints.md @@ -295,8 +295,14 @@ impl EarlyLintPass for FooFunctions { Running our UI test should now produce output that contains the lint message. +According to [the rustc-dev-guide], the text should be matter of fact and avoid +capitalization and periods, unless multiple sentences are needed. +When code or an identifier must appear in a message or label, it should be +surrounded with single acute accents \`. + [check_fn]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/trait.EarlyLintPass.html#method.check_fn [diagnostics]: https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/src/utils/diagnostics.rs +[the rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/diagnostics.html ## Adding the lint logic |