|
1 |
| -error: empty line after doc comment |
2 |
| - --> tests/ui/doc/unbalanced_ticks.rs:7:1 |
| 1 | +error: backticks are unbalanced |
| 2 | + --> tests/ui/doc/unbalanced_ticks.rs:7:5 |
3 | 3 | |
|
4 |
| -LL | / /// This is a doc comment with `unbalanced_tick marks and several words that |
| 4 | +LL | /// This is a doc comment with `unbalanced_tick marks and several words that |
| 5 | + | _____^ |
5 | 6 | LL | |
|
6 |
| -LL | | |
7 |
| - | |_^ |
8 |
| -... |
9 |
| -LL | fn main() {} |
10 |
| - | --------- the comment documents this function |
11 |
| - | |
12 |
| - = note: `-D clippy::empty-line-after-doc-comments` implied by `-D warnings` |
13 |
| - = help: to override `-D warnings` add `#[allow(clippy::empty_line_after_doc_comments)]` |
14 |
| - = help: if the empty line is unintentional remove it |
15 |
| -help: if the doc comment should not document `main` comment it out |
16 |
| - | |
17 |
| -LL | // /// This is a doc comment with `unbalanced_tick marks and several words that |
18 |
| - | ++ |
| 7 | +LL | | /// should be `encompassed_by` tick marks because they `contain_underscores`. |
| 8 | +LL | | /// Because of the initial `unbalanced_tick` pair, the error message is |
| 9 | +LL | | /// very `confusing_and_misleading`. |
| 10 | + | |____________________________________^ |
| 11 | + | |
| 12 | + = help: a backtick may be missing a pair |
| 13 | + = note: `-D clippy::doc-markdown` implied by `-D warnings` |
| 14 | + = help: to override `-D warnings` add `#[allow(clippy::doc_markdown)]` |
19 | 15 |
|
20 |
| -error: empty lines after doc comment |
21 |
| - --> tests/ui/doc/unbalanced_ticks.rs:15:1 |
| 16 | +error: backticks are unbalanced |
| 17 | + --> tests/ui/doc/unbalanced_ticks.rs:14:5 |
22 | 18 | |
|
23 |
| -LL | / /// This paragraph has `unbalanced_tick marks and should stop_linting. |
24 |
| -LL | | |
25 |
| -LL | | |
26 |
| -LL | | /// |
27 |
| -... | |
28 |
| -LL | | /// Double unbalanced backtick from ``here to here` should lint. |
29 |
| -LL | | |
30 |
| - | |_^ |
31 |
| -... |
32 |
| -LL | fn multiple_paragraphs() {} |
33 |
| - | ------------------------ the comment documents this function |
34 |
| - | |
35 |
| - = help: if the empty lines are unintentional remove them |
36 |
| -help: if the doc comment should not document `multiple_paragraphs` comment it out |
37 |
| - | |
38 |
| -LL ~ // /// This paragraph has `unbalanced_tick marks and should stop_linting. |
39 |
| -LL | |
40 |
| -LL | |
41 |
| -LL ~ // /// |
42 |
| -LL ~ // /// This paragraph is fine and should_be linted normally. |
43 |
| -LL | |
44 |
| -LL ~ // /// |
45 |
| -LL ~ // /// Double unbalanced backtick from ``here to here` should lint. |
| 19 | +LL | /// This paragraph has `unbalanced_tick marks and should stop_linting. |
| 20 | + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
46 | 21 | |
|
| 22 | + = help: a backtick may be missing a pair |
47 | 23 |
|
48 |
| -error: empty lines after doc comment |
49 |
| - --> tests/ui/doc/unbalanced_ticks.rs:36:1 |
| 24 | +error: item in documentation is missing backticks |
| 25 | + --> tests/ui/doc/unbalanced_ticks.rs:17:32 |
50 | 26 | |
|
51 |
| -LL | / /// ## not_fine |
52 |
| -LL | | |
53 |
| -LL | | |
54 |
| -LL | | /// |
55 |
| -... | |
56 |
| -LL | | /// - This item needs backticks_here |
57 |
| -LL | | |
58 |
| - | |_^ |
59 |
| -LL | fn other_markdown() {} |
60 |
| - | ------------------- the comment documents this function |
61 |
| - | |
62 |
| - = help: if the empty lines are unintentional remove them |
63 |
| -help: if the doc comment should not document `other_markdown` comment it out |
64 |
| - | |
65 |
| -LL ~ // /// # `Fine` |
66 |
| -LL ~ // /// |
67 |
| -LL ~ // /// ## not_fine |
68 |
| -LL | |
69 |
| -LL | |
70 |
| -LL ~ // /// |
71 |
| -LL ~ // /// ### `unbalanced |
72 |
| -LL | |
73 |
| -LL ~ // /// |
74 |
| -LL ~ // /// - This `item has unbalanced tick marks |
75 |
| -LL | |
76 |
| -LL ~ // /// - This item needs backticks_here |
| 27 | +LL | /// This paragraph is fine and should_be linted normally. |
| 28 | + | ^^^^^^^^^ |
77 | 29 | |
|
| 30 | +help: try |
| 31 | + | |
| 32 | +LL | /// This paragraph is fine and `should_be` linted normally. |
| 33 | + | ~~~~~~~~~~~ |
78 | 34 |
|
79 |
| -error: empty line after doc comment |
80 |
| - --> tests/ui/doc/unbalanced_ticks.rs:56:1 |
| 35 | +error: backticks are unbalanced |
| 36 | + --> tests/ui/doc/unbalanced_ticks.rs:20:5 |
81 | 37 | |
|
82 |
| -LL | / /// ` |
83 |
| -LL | | |
84 |
| -LL | | |
85 |
| - | |_^ |
86 |
| -LL | fn escape_0() {} |
87 |
| - | ------------- the comment documents this function |
| 38 | +LL | /// Double unbalanced backtick from ``here to here` should lint. |
| 39 | + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
88 | 40 | |
|
89 |
| - = help: if the empty line is unintentional remove it |
90 |
| -help: if the doc comment should not document `escape_0` comment it out |
| 41 | + = help: a backtick may be missing a pair |
| 42 | + |
| 43 | +error: item in documentation is missing backticks |
| 44 | + --> tests/ui/doc/unbalanced_ticks.rs:34:8 |
91 | 45 | |
|
92 |
| -LL | // /// ` |
93 |
| - | ++ |
| 46 | +LL | /// ## not_fine |
| 47 | + | ^^^^^^^^ |
| 48 | + | |
| 49 | +help: try |
| 50 | + | |
| 51 | +LL | /// ## `not_fine` |
| 52 | + | ~~~~~~~~~~ |
94 | 53 |
|
95 |
| -error: empty line after doc comment |
96 |
| - --> tests/ui/doc/unbalanced_ticks.rs:67:1 |
| 54 | +error: backticks are unbalanced |
| 55 | + --> tests/ui/doc/unbalanced_ticks.rs:37:5 |
97 | 56 | |
|
98 |
| -LL | / /// Escaped \` ` backticks don't count, but unescaped backticks do. |
99 |
| -LL | | |
100 |
| -LL | | |
101 |
| - | |_^ |
102 |
| -LL | fn escape_3() {} |
103 |
| - | ------------- the comment documents this function |
| 57 | +LL | /// ### `unbalanced |
| 58 | + | ^^^^^^^^^^^^^^^ |
| 59 | + | |
| 60 | + = help: a backtick may be missing a pair |
| 61 | + |
| 62 | +error: backticks are unbalanced |
| 63 | + --> tests/ui/doc/unbalanced_ticks.rs:40:5 |
| 64 | + | |
| 65 | +LL | /// - This `item has unbalanced tick marks |
| 66 | + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 67 | + | |
| 68 | + = help: a backtick may be missing a pair |
| 69 | + |
| 70 | +error: item in documentation is missing backticks |
| 71 | + --> tests/ui/doc/unbalanced_ticks.rs:42:23 |
| 72 | + | |
| 73 | +LL | /// - This item needs backticks_here |
| 74 | + | ^^^^^^^^^^^^^^ |
| 75 | + | |
| 76 | +help: try |
| 77 | + | |
| 78 | +LL | /// - This item needs `backticks_here` |
| 79 | + | ~~~~~~~~~~~~~~~~ |
| 80 | + |
| 81 | +error: backticks are unbalanced |
| 82 | + --> tests/ui/doc/unbalanced_ticks.rs:53:5 |
| 83 | + | |
| 84 | +LL | /// ` |
| 85 | + | ^ |
| 86 | + | |
| 87 | + = help: a backtick may be missing a pair |
| 88 | + |
| 89 | +error: backticks are unbalanced |
| 90 | + --> tests/ui/doc/unbalanced_ticks.rs:63:5 |
104 | 91 | |
|
105 |
| - = help: if the empty line is unintentional remove it |
106 |
| -help: if the doc comment should not document `escape_3` comment it out |
| 92 | +LL | /// Escaped \` ` backticks don't count, but unescaped backticks do. |
| 93 | + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
107 | 94 | |
|
108 |
| -LL | // /// Escaped \` ` backticks don't count, but unescaped backticks do. |
109 |
| - | ++ |
| 95 | + = help: a backtick may be missing a pair |
110 | 96 |
|
111 |
| -error: aborting due to 5 previous errors |
| 97 | +error: aborting due to 10 previous errors |
112 | 98 |
|
0 commit comments