Add a doc comment for eval_mir_constant

Co-authored-by: Ralf Jung <post@ralfj.de>
fmease · Jan 23, 2024 · c8a675d · c8a675d
1 parent 245afd7
commit c8a675d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/compiler/rustc_const_eval/src/interpret/machine.rs b/compiler/rustc_const_eval/src/interpret/machine.rs
@@ -512,6 +512,8 @@ pub trait Machine<'mir, 'tcx: 'mir>: Sized {
         Ok(())
     }
 
+    /// Evaluate the given constant. The `eval` function will do all the required evaluation,
+    /// but this hook has the chance to do some pre/postprocessing.
     #[inline(always)]
     fn eval_mir_constant<F>(
         ecx: &InterpCx<'mir, 'tcx, Self>,