clippy 0.0.124

A bunch of helpful lints to avoid common pitfalls in Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286

error: missing documentation for a type alias
  --> $DIR/missing-doc.rs:26:1
   |
26 | type Typedef = String;
   | ^^^^^^^^^^^^^^^^^^^^^^
   |
note: lint level defined here
  --> $DIR/missing-doc.rs:16:9
   |
16 | #![deny(missing_docs_in_private_items)]
   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a type alias
  --> $DIR/missing-doc.rs:27:1
   |
27 | pub type PubTypedef = String;
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a struct
  --> $DIR/missing-doc.rs:29:1
   |
29 |   struct Foo {
   |  _^ starting here...
30 | |     a: isize,
31 | |     b: isize,
32 | | }
   | |_^ ...ending here

error: missing documentation for a struct field
  --> $DIR/missing-doc.rs:30:5
   |
30 |     a: isize,
   |     ^^^^^^^^

error: missing documentation for a struct field
  --> $DIR/missing-doc.rs:31:5
   |
31 |     b: isize,
   |     ^^^^^^^^

error: missing documentation for a struct
  --> $DIR/missing-doc.rs:34:1
   |
34 |   pub struct PubFoo {
   |  _^ starting here...
35 | |     pub a: isize,
36 | |     b: isize,
37 | | }
   | |_^ ...ending here

error: missing documentation for a struct field
  --> $DIR/missing-doc.rs:35:5
   |
35 |     pub a: isize,
   |     ^^^^^^^^^^^^

error: missing documentation for a struct field
  --> $DIR/missing-doc.rs:36:5
   |
36 |     b: isize,
   |     ^^^^^^^^

error: missing documentation for a module
  --> $DIR/missing-doc.rs:45:1
   |
45 | mod module_no_dox {}
   | ^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a module
  --> $DIR/missing-doc.rs:46:1
   |
46 | pub mod pub_module_no_dox {}
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a function
  --> $DIR/missing-doc.rs:50:1
   |
50 | pub fn foo2() {}
   | ^^^^^^^^^^^^^^^^

error: missing documentation for a function
  --> $DIR/missing-doc.rs:51:1
   |
51 | fn foo3() {}
   | ^^^^^^^^^^^^

error: missing documentation for a trait
  --> $DIR/missing-doc.rs:68:1
   |
68 |   pub trait C {
   |  _^ starting here...
69 | |     fn foo(&self);
70 | |     fn foo_with_impl(&self) {}
71 | | }
   | |_^ ...ending here

error: missing documentation for a trait method
  --> $DIR/missing-doc.rs:69:5
   |
69 |     fn foo(&self);
   |     ^^^^^^^^^^^^^^

error: missing documentation for a trait method
  --> $DIR/missing-doc.rs:70:5
   |
70 |     fn foo_with_impl(&self) {}
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for an associated type
  --> $DIR/missing-doc.rs:80:5
   |
80 |     type AssociatedType;
   |     ^^^^^^^^^^^^^^^^^^^^

error: missing documentation for an associated type
  --> $DIR/missing-doc.rs:81:5
   |
81 |     type AssociatedTypeDef = Self;
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a method
  --> $DIR/missing-doc.rs:92:5
   |
92 |     pub fn foo() {}
   |     ^^^^^^^^^^^^^^^

error: missing documentation for a method
  --> $DIR/missing-doc.rs:93:5
   |
93 |     fn bar() {}
   |     ^^^^^^^^^^^

error: missing documentation for a method
  --> $DIR/missing-doc.rs:97:5
   |
97 |     pub fn foo() {}
   |     ^^^^^^^^^^^^^^^

error: missing documentation for a method
   --> $DIR/missing-doc.rs:100:5
    |
100 |     fn foo2() {}
    |     ^^^^^^^^^^^^

error: missing documentation for an enum
   --> $DIR/missing-doc.rs:126:1
    |
126 |   enum Baz {
    |  _^ starting here...
127 | |     BazA {
128 | |         a: isize,
129 | |         b: isize
130 | |     },
131 | |     BarB
132 | | }
    | |_^ ...ending here

error: missing documentation for a variant
   --> $DIR/missing-doc.rs:127:5
    |
127 |       BazA {
    |  _____^ starting here...
128 | |         a: isize,
129 | |         b: isize
130 | |     },
    | |_____^ ...ending here

error: missing documentation for a struct field
   --> $DIR/missing-doc.rs:128:9
    |
128 |         a: isize,
    |         ^^^^^^^^

error: missing documentation for a struct field
   --> $DIR/missing-doc.rs:129:9
    |
129 |         b: isize
    |         ^^^^^^^^

error: missing documentation for a variant
   --> $DIR/missing-doc.rs:131:5
    |
131 |     BarB
    |     ^^^^

error: missing documentation for an enum
   --> $DIR/missing-doc.rs:134:1
    |
134 |   pub enum PubBaz {
    |  _^ starting here...
135 | |     PubBazA {
136 | |         a: isize,
137 | |     },
138 | | }
    | |_^ ...ending here

error: missing documentation for a variant
   --> $DIR/missing-doc.rs:135:5
    |
135 |       PubBazA {
    |  _____^ starting here...
136 | |         a: isize,
137 | |     },
    | |_____^ ...ending here

error: missing documentation for a struct field
   --> $DIR/missing-doc.rs:136:9
    |
136 |         a: isize,
    |         ^^^^^^^^

error: missing documentation for a constant
   --> $DIR/missing-doc.rs:160:1
    |
160 | const FOO: u32 = 0;
    | ^^^^^^^^^^^^^^^^^^^

error: missing documentation for a constant
   --> $DIR/missing-doc.rs:167:1
    |
167 | pub const FOO4: u32 = 0;
    | ^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a static
   --> $DIR/missing-doc.rs:170:1
    |
170 | static BAR: u32 = 0;
    | ^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a static
   --> $DIR/missing-doc.rs:177:1
    |
177 | pub static BAR4: u32 = 0;
    | ^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a module
   --> $DIR/missing-doc.rs:180:1
    |
180 |   mod internal_impl {
    |  _^ starting here...
181 | |     /// dox
182 | |     pub fn documented() {}
183 | |     pub fn undocumented1() {}
...   |
192 | |     }
193 | | }
    | |_^ ...ending here

error: missing documentation for a function
   --> $DIR/missing-doc.rs:183:5
    |
183 |     pub fn undocumented1() {}
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a function
   --> $DIR/missing-doc.rs:184:5
    |
184 |     pub fn undocumented2() {}
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a function
   --> $DIR/missing-doc.rs:185:5
    |
185 |     fn undocumented3() {}
    |     ^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a function
   --> $DIR/missing-doc.rs:190:9
    |
190 |         pub fn also_undocumented1() {}
    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a function
   --> $DIR/missing-doc.rs:191:9
    |
191 |         fn also_undocumented2() {}
    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a function
   --> $DIR/missing-doc.rs:202:1
    |
202 | fn main() {}
    | ^^^^^^^^^^^^

error: aborting due to 40 previous errors