]> git.lizzy.rs Git - rust.git/commitdiff
Correct documentation about `FakeRead`
authorOliver Scherer <github35764891676564198441@oli-obk.de>
Wed, 12 Dec 2018 12:09:36 +0000 (13:09 +0100)
committerOliver Scherer <github35764891676564198441@oli-obk.de>
Wed, 12 Dec 2018 12:09:36 +0000 (13:09 +0100)
src/librustc/mir/mod.rs

index faecb7013b492513087941f9271dc4d2d44cf0f9..7b158c3958d4a2e9ea4cc40c80546b72eae7bb46 100644 (file)
@@ -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.