Skip to content

Commit 27aa7e4

Browse files
authored
Unrolled build for #141728
Rollup merge of #141728 - JonathanBrouwer:fix-docs, r=compiler-errors Fix false documentation of FnCtxt::diverges While I was working on another issue I came across this false documentation, and was mislead by it. Therefore I decided to fix this :) The newly documented usecase is located here: https://github.com/rust-lang/rust/blob/38081f22c2d7380f272aa1d7fa9b935637701c2d/compiler/rustc_hir_typeck/src/fn_ctxt/checks.rs#L1968
2 parents 1bbd62e + 8e5d579 commit 27aa7e4

File tree

1 file changed

+3
-1
lines changed
  • compiler/rustc_hir_typeck/src/fn_ctxt

1 file changed

+3
-1
lines changed

compiler/rustc_hir_typeck/src/fn_ctxt/mod.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ pub(crate) struct FnCtxt<'a, 'tcx> {
8181
/// you get indicates whether any subexpression that was
8282
/// evaluating up to and including `X` diverged.
8383
///
84-
/// We currently use this flag only for diagnostic purposes:
84+
/// We currently use this flag for the following purposes:
8585
///
8686
/// - To warn about unreachable code: if, after processing a
8787
/// sub-expression but before we have applied the effects of the
@@ -94,6 +94,8 @@ pub(crate) struct FnCtxt<'a, 'tcx> {
9494
/// warning. This corresponds to something like `{return;
9595
/// foo();}` or `{return; 22}`, where we would warn on the
9696
/// `foo()` or `22`.
97+
/// - To assign the `!` type to block expressions with diverging
98+
/// statements.
9799
///
98100
/// An expression represents dead code if, after checking it,
99101
/// the diverges flag is set to something other than `Maybe`.

0 commit comments

Comments
 (0)