From c1ed84e6eccbd57dde9b69e2defd4d79faf41b1f Mon Sep 17 00:00:00 2001 From: jumbatm Date: Wed, 12 Feb 2020 08:37:06 +1000 Subject: [PATCH] Fix outdated doc comment. --- src/librustc/mir/interpret/error.rs | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/librustc/mir/interpret/error.rs b/src/librustc/mir/interpret/error.rs index df3971a5ac3f1..86e7bb28e0069 100644 --- a/src/librustc/mir/interpret/error.rs +++ b/src/librustc/mir/interpret/error.rs @@ -128,10 +128,9 @@ impl<'tcx> ConstEvalErr<'tcx> { } } - /// Sets the message passed in via `message`, then adds the span labels for you, before applying - /// further modifications in `emit`. It's up to you to call emit(), stash(..), etc. within the - /// `emit` method. If you don't need to do any additional processing, just use - /// struct_generic. + /// Sets the message passed in via `message` and adds span labels before handing control back + /// to `emit` to do any final processing. It's the caller's responsibility to call emit(), + /// stash(), etc. within the `emit` function to dispose of the diagnostic properly. fn struct_generic( &self, tcx: TyCtxtAt<'tcx>,