]> git.lizzy.rs Git - rust.git/blob - src/docs/doc_link_with_quotes.txt
[Arithmetic] Consider literals
[rust.git] / src / docs / doc_link_with_quotes.txt
1 ### What it does
2 Detects the syntax `['foo']` in documentation comments (notice quotes instead of backticks)
3 outside of code blocks
4 ### Why is this bad?
5 It is likely a typo when defining an intra-doc link
6
7 ### Example
8 ```
9 /// See also: ['foo']
10 fn bar() {}
11 ```
12 Use instead:
13 ```
14 /// See also: [`foo`]
15 fn bar() {}
16 ```