Unnamed repository; edit this file 'description' to name the repository.
Diffstat (limited to 'crates/ide-assists/src/handlers/replace_arith_with_saturating.rs')
-rw-r--r--crates/ide-assists/src/handlers/replace_arith_with_saturating.rs15
1 files changed, 15 insertions, 0 deletions
diff --git a/crates/ide-assists/src/handlers/replace_arith_with_saturating.rs b/crates/ide-assists/src/handlers/replace_arith_with_saturating.rs
index 8c620ad93f..717875e84f 100644
--- a/crates/ide-assists/src/handlers/replace_arith_with_saturating.rs
+++ b/crates/ide-assists/src/handlers/replace_arith_with_saturating.rs
@@ -1,6 +1,21 @@
use crate::assist_context::{AssistContext, Assists};
use crate::utils::{replace_arith, ArithKind};
+// Assist: replace_arith_with_saturating
+//
+// Replaces arithmetic on integers with the `saturating_*` equivalent.
+//
+// ```
+// fn main() {
+// let x = 1 $0+ 2;
+// }
+// ```
+// ->
+// ```
+// fn main() {
+// let x = 1.saturating_add(2);
+// }
+// ```
pub(crate) fn replace_arith_with_saturating(
acc: &mut Assists,
ctx: &AssistContext<'_>,