about summary refs log tree commit diff
diff options
context:
space:
mode:
authorOli Scherer <git-spam-no-reply9815368754983@oli-obk.de>2024-01-24 11:04:13 +0000
committerOli Scherer <git-spam-no-reply9815368754983@oli-obk.de>2024-01-24 11:04:13 +0000
commitcc34dc2bc7a76f7a3e038f567d11f0ac88a0e677 (patch)
treed172fbd57ec2ba11d2c038d78ec0436cef05c357
parentdb7cd5709133ef4a0e45bc13b1b3db7cbf1b3c8f (diff)
downloadrust-cc34dc2bc7a76f7a3e038f567d11f0ac88a0e677.tar.gz
rust-cc34dc2bc7a76f7a3e038f567d11f0ac88a0e677.zip
Correctly explain `ensure_forwards_result_if_red`
-rw-r--r--compiler/rustc_macros/src/query.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/compiler/rustc_macros/src/query.rs b/compiler/rustc_macros/src/query.rs
index ad1980136f3..25675e06e38 100644
--- a/compiler/rustc_macros/src/query.rs
+++ b/compiler/rustc_macros/src/query.rs
@@ -120,7 +120,8 @@ struct QueryModifiers {
 
     /// Forward the result on ensure if the query gets recomputed, and
     /// return `Ok(())` otherwise. Only applicable to queries returning
-    /// `Result<(), ErrorGuaranteed>`
+    /// `Result<T, ErrorGuaranteed>`. The `T` is not returned from `ensure`
+    /// invocations.
     ensure_forwards_result_if_red: Option<Ident>,
 }