From 18f6922d8cf13625ae067b9061c017f44b4427ea Mon Sep 17 00:00:00 2001 From: Joshua Nelson Date: Mon, 3 May 2021 22:19:49 -0400 Subject: [PATCH] Address review comments - Simplify boolean expression - Give an example of invalid syntax - Remove explanation of why code block is text --- .../src/borrow_check/region_infer/mod.rs | 2 +- src/doc/rustdoc/src/lints.md | 33 +++++++++++-------- .../passes/check_code_block_syntax.rs | 2 +- 3 files changed, 22 insertions(+), 15 deletions(-) diff --git a/compiler/rustc_mir/src/borrow_check/region_infer/mod.rs b/compiler/rustc_mir/src/borrow_check/region_infer/mod.rs index 9dc2e3d2923..f4d78ac04cb 100644 --- a/compiler/rustc_mir/src/borrow_check/region_infer/mod.rs +++ b/compiler/rustc_mir/src/borrow_check/region_infer/mod.rs @@ -1241,7 +1241,7 @@ impl<'tcx> RegionInferenceContext<'tcx> { /// it. However, it works pretty well in practice. In particular, /// this is needed to deal with projection outlives bounds like /// - /// ```text (internal compiler representation so lifetime syntax is invalid) + /// ```text /// >::Item: '1 /// ``` /// diff --git a/src/doc/rustdoc/src/lints.md b/src/doc/rustdoc/src/lints.md index 9f1e1a5b88b..16b091eb255 100644 --- a/src/doc/rustdoc/src/lints.md +++ b/src/doc/rustdoc/src/lints.md @@ -305,30 +305,37 @@ examples that are invalid (e.g. empty, not parsable as Rust). For example: /// ```rust /// ``` /// -/// Unclosed code blocks (with and without the `rust` marker): +/// Invalid syntax in code blocks: /// /// ```rust -fn main() {} +/// '< +/// ``` +pub fn foo() {} ``` Which will give: ```text warning: Rust code block is empty ---> src/lib.rs:3:5 -| + --> lint.rs:3:5 + | 3 | /// ```rust -| _____^ + | _____^ 4 | | /// ``` -| |_______^ -| -= note: `#[warn(rustdoc::invalid_rust_codeblocks)]` on by default + | |_______^ + | + = note: `#[warn(rustdoc::invalid_rust_codeblocks)]` on by default -warning: Rust code block is empty ---> src/lib.rs:8:5 -| -8 | /// ```rust -| ^^^^^^^ +warning: could not parse code block as Rust code + --> lint.rs:8:5 + | +8 | /// ```rust + | _____^ +9 | | /// '< +10 | | /// ``` + | |_______^ + | + = note: error from rustc: unterminated character literal ``` ## bare_urls diff --git a/src/librustdoc/passes/check_code_block_syntax.rs b/src/librustdoc/passes/check_code_block_syntax.rs index 72d3e9544c4..0b94a74eeef 100644 --- a/src/librustdoc/passes/check_code_block_syntax.rs +++ b/src/librustdoc/passes/check_code_block_syntax.rs @@ -48,7 +48,7 @@ impl<'a, 'tcx> SyntaxChecker<'a, 'tcx> { .unwrap_or(false); let buffer = buffer.borrow(); - if !(buffer.has_errors || is_empty) { + if !buffer.has_errors && !is_empty { // No errors in a non-empty program. return; }