about summary refs log tree commit diff
diff options
context:
space:
mode:
authorxFrednet <xFrednet@gmail.com>2021-01-05 23:59:14 +0100
committerxFrednet <xFrednet@gmail.com>2021-04-05 13:33:45 +0200
commit232e2b79f2e76cc7e1c76e0d35968711960dedee (patch)
tree95da3c09fdf61c55eea4bd024c66be33e9465c3c
parent81f99460b1ee33e1f0b0764e827abee03a53e42f (diff)
downloadrust-232e2b79f2e76cc7e1c76e0d35968711960dedee.tar.gz
rust-232e2b79f2e76cc7e1c76e0d35968711960dedee.zip
Added documentation to the multispan_sugg method
-rw-r--r--clippy_utils/src/diagnostics.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/clippy_utils/src/diagnostics.rs b/clippy_utils/src/diagnostics.rs
index 73a2fa992b3..7f827f1759d 100644
--- a/clippy_utils/src/diagnostics.rs
+++ b/clippy_utils/src/diagnostics.rs
@@ -218,6 +218,11 @@ where
     multispan_sugg_with_applicability(diag, help_msg, Applicability::Unspecified, sugg)
 }
 
+/// Create a suggestion made from several `span → replacement`.
+///
+/// rustfix currently doesn't support the automatic application of suggestions with
+/// multiple spans. This is tracked in issue [rustfix#141](https://github.com/rust-lang/rustfix/issues/141).
+/// Suggestions with multiple spans will be silently ignored.
 pub fn multispan_sugg_with_applicability<I>(
     diag: &mut DiagnosticBuilder<'_>,
     help_msg: &str,