about summary refs log tree commit diff
diff options
context:
space:
mode:
authorAaron Hill <aa1ronham@gmail.com>2019-11-04 13:49:50 -0500
committerAaron Hill <aa1ronham@gmail.com>2019-11-11 15:14:36 -0500
commitc062afe73ddb8aaab4c475530330404b62e2d58d (patch)
treea0773ff4367c049846422a15c678789cabc8dbca
parentdac30115dc674b0d636018dfa7c1e31095078425 (diff)
downloadrust-c062afe73ddb8aaab4c475530330404b62e2d58d.tar.gz
rust-c062afe73ddb8aaab4c475530330404b62e2d58d.zip
Make doc comment more accurate
-rw-r--r--src/librustc_mir/interpret/machine.rs5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/librustc_mir/interpret/machine.rs b/src/librustc_mir/interpret/machine.rs
index bed6c0b67eb..08da5078f43 100644
--- a/src/librustc_mir/interpret/machine.rs
+++ b/src/librustc_mir/interpret/machine.rs
@@ -24,7 +24,10 @@ pub enum StackPopInfo {
     /// as the result of panic
     StartUnwinding,
 
-    /// Indicates that we performed a normal return
+    /// Indicates that no special handling should be
+    /// done - we'll either return normally or unwind
+    /// based on the terminator for the function
+    /// we're leaving.
     Normal,
 
     /// Indicates that we should stop unwinding,