doc_link_with_quotes false postive for code inside code block

[dtolnay]

Summary

The doc_link_with_quotes lint is documented as:

Detects the syntax ['foo'] in documentation comments (notice quotes instead of backticks) outside of code blocks

However it is incorrectly triggering on code inside of code blocks.

Lint Name

doc_link_with_quotes

Reproducer

/// This is a code block:
///
/// ```
/// let _ = vec!['w', 'a', 't'];
/// ```
fn main() {}

error: possible intra-doc link using quotes instead of backticks
 --> src/main.rs:4:1
  |
4 | /// let _ = vec!['w', 'a', 't'];
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  |
  = note: `-D clippy::doc-link-with-quotes` implied by `-D clippy::pedantic`
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_link_with_quotes

It is indeed a code block though.

Mentioning @cameron1024 since this lint was recently added in #8385.

Version

rustc 1.63.0-nightly (50b00252a 2022-06-06)
binary: rustc
commit-hash: 50b00252aeb77b10db04d65dc9e12ce758def4b5
commit-date: 2022-06-06
host: x86_64-unknown-linux-gnu
release: 1.63.0-nightly
LLVM version: 14.0.5

Additional Labels

No response

[cameron1024]

Hmm this looks pretty bad, I'll have a look at this. I'm pretty new to clippy so I'm not sure how long it will take 😅

[cameron1024]

Hmm this looks pretty bad, I'll have a look at this. I'm pretty new to clippy though so I'm not sure how long it will take 😅

[tamaroning]

@cameron1024
Hi, this lint seems not to deal with code blocks (``` ... ```) for now.
You should

1. add in_code_block: bool field to DocLinkWithQuotes struct by manually declaring the struct (See this)
2. add a logic which change its value when bumping into ```.
3. add tests

If you do not tackle with this, it is ok and I am going to assign this to me😀

[Alexendoo]

doc.rs contains code that reassembles + parses markdown from doc comments, the lint could be down by replacing fake_broken_link_callback with a closure that checks if the link is enclosed in '. That would also avoid any weird behaviour with backticks appearing in code blocks

rust-clippy/clippy_lints/src/doc.rs

Lines 470 to 473 in b3c94c0

	let mut cb = fake_broken_link_callback;
	let parser =
	pulldown_cmark::Parser::new_with_broken_link_callback(&doc, Options::empty(), Some(&mut cb)).into_offset_iter();

[ikopysov]

@rustbot claim

[ikopysov]

Sorry, came here because #9321 tagged as "good-first-issue" but this markdown parser seems too complex for me to understand how it should be implemented.
Maybe it was tagged as such with first change in ming (ignoring everything in the ``` code block), but with parser I don't believe it's actually good issue to start with.

[Alexendoo]

That's fair, I'll close that one as a duplicate