about summary refs log tree commit diff
diff options
context:
space:
mode:
authorOliver Scherer <github35764891676564198441@oli-obk.de>2018-12-12 13:09:36 +0100
committerOliver Scherer <github35764891676564198441@oli-obk.de>2018-12-12 13:09:36 +0100
commit6ca2ad584459b62e444e726af6ec958c31c77c1d (patch)
tree5fe141ab1b6dff6eaf9a2ea67b9521f898eecd89
parent2cb5e3d49045f9fe5b315b3cdf33da561b5b467d (diff)
downloadrust-6ca2ad584459b62e444e726af6ec958c31c77c1d.tar.gz
rust-6ca2ad584459b62e444e726af6ec958c31c77c1d.zip
Correct documentation about `FakeRead`
-rw-r--r--src/librustc/mir/mod.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/librustc/mir/mod.rs b/src/librustc/mir/mod.rs
index faecb7013b4..7b158c3958d 100644
--- a/src/librustc/mir/mod.rs
+++ b/src/librustc/mir/mod.rs
@@ -1760,7 +1760,8 @@ pub enum StatementKind<'tcx> {
     /// kind of pattern it comes from. This is in order to adapt potential
     /// error messages to these specific patterns.
     ///
-    /// Note that this also is emitted for regular `let` bindings to aid destructuring diagnostics
+    /// Note that this also is emitted for regular `let` bindings to ensure that locals that are
+    /// never accessed still get some sanity checks for e.g. `let x: ! = ..;`
     FakeRead(FakeReadCause, Place<'tcx>),
 
     /// Write the discriminant for a variant to the enum Place.