Correctly explain ensure_forwards_result_if_red

oli-obk · oli-obk · commit cc34dc2bc7a7 · 2024-01-24T11:04:13.000Z
diff --git 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>,
 }
 

Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,8 @@ struct QueryModifiers {`
`120`	`120`
`121`	`121`	`/// Forward the result on ensure if the query gets recomputed, and`
`122`	`122`	/// return `Ok(())` otherwise. Only applicable to queries returning
`123`		- /// `Result<(), ErrorGuaranteed>`
	`123`	+ /// `Result<T, ErrorGuaranteed>`. The `T` is not returned from `ensure`
	`124`	`+ /// invocations.`
`124`	`125`	`ensure_forwards_result_if_red: Option<Ident>,`
`125`	`126`	`}`
`126`	`127`