add doc_link_with_quotes lint by cameron1024 · Pull Request #8385 · rust-lang/ru... - JOYK Joy of Geek, Geek News, Link all geek

Conversation

Contributor

cameron1024 commented on Feb 1 •

edited by llogiq

I'm not sure about wording, it seems OK to me but happy to change if other people have better ideas

closes #8383

changelog: add [doc_link_with_quotes] lint

Collaborator

rust-highfive commented on Feb 1

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @llogiq (or someone else) soon.

Please see the contribution instructions for more information.

rust-highfive

added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label

on Feb 1

Contributor

llogiq left a comment

I think we should look at more cases to ensure the false positive rate is low. The best way would presumably to check if the link text contains a valid path, but that may be too complex.

tests/ui/doc_link_with_quotes.rs

		bar()
		}

		pub fn bar() {}

Contributor

llogiq on Feb 1

I'd like to see a test case against false positives, e.g.

/// ['This week in Rust'](https://this-week-in-rust.org)
fn twir() {}

cameron1024 reacted with thumbs up emoji

Contributor

Author

cameron1024 commented on Feb 2

The particular case that motivated my example was looking for broken links, but I came across something with a broken link and quotes instead of backticks. Ideally the lint would catch these, but I guess that comes at the cost of false positives. Anecdotally, the use of ['something'] seems to be mostly limited to being already within backticks, but I haven't gathered any data for that

Though if by "valid path" you mean a much simpler syntactic check (rather than checking if it points to an actual item), that sounds reasonable. i.e.: