about summary refs log tree commit diff
path: root/clippy_dev/src/ra_setup.rs
diff options
context:
space:
mode:
authorCaden Haustein <code@brightlysalty.33mail.com>2020-12-30 16:37:59 -0600
committerflip1995 <philipp.krones@embecosm.com>2021-02-02 16:36:32 +0100
commitbde667af7e7d512978daff3bc2b540bb913bd6a1 (patch)
tree6b66300b6471c6cbacd87cdbe82e33a42d557be4 /clippy_dev/src/ra_setup.rs
parentf870876d925b5dd115c9d792783dc6208e33d913 (diff)
downloadrust-bde667af7e7d512978daff3bc2b540bb913bd6a1.tar.gz
rust-bde667af7e7d512978daff3bc2b540bb913bd6a1.zip
Add missing_panics_doc lint
Diffstat (limited to 'clippy_dev/src/ra_setup.rs')
-rw-r--r--clippy_dev/src/ra_setup.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/clippy_dev/src/ra_setup.rs b/clippy_dev/src/ra_setup.rs
index a8a6a2cb1bd..a3c329b578b 100644
--- a/clippy_dev/src/ra_setup.rs
+++ b/clippy_dev/src/ra_setup.rs
@@ -8,6 +8,9 @@ use std::path::{Path, PathBuf};
 // This allows rust analyzer to analyze rustc internals and show proper information inside clippy
 // code. See https://github.com/rust-analyzer/rust-analyzer/issues/3517 and https://github.com/rust-lang/rust-clippy/issues/5514 for details
 
+/// # Panics
+///
+/// Panics if `rustc_path` does not lead to a rustc repo or the files could not be read
 pub fn run(rustc_path: Option<&str>) {
     // we can unwrap here because the arg is required by clap
     let rustc_path = PathBuf::from(rustc_path.unwrap());