Set the limit of characters to 200 and don't run the lint on private items unless config allows it

This commit is contained in:
Guillaume Gomez 2024-07-09 16:00:06 +02:00
parent 855a9d1377
commit f455587fee
6 changed files with 37 additions and 18 deletions

View file

@ -4,5 +4,6 @@
///
/// A much longer explanation that goes into a lot more detail about
/// how the thing works, possibly with doclinks and so one,
/// and probably spanning a many rows.
struct Foo;
/// and probably spanning a many rows. Blablabla, it needs to be over
/// 200 characters so I needed to write something longeeeeeeer.
pub struct Foo;

View file

@ -3,5 +3,6 @@
/// A very short summary.
/// A much longer explanation that goes into a lot more detail about
/// how the thing works, possibly with doclinks and so one,
/// and probably spanning a many rows.
struct Foo;
/// and probably spanning a many rows. Blablabla, it needs to be over
/// 200 characters so I needed to write something longeeeeeeer.
pub struct Foo;

View file

@ -4,7 +4,8 @@ error: first doc comment paragraph is too long
LL | / /// A very short summary.
LL | | /// A much longer explanation that goes into a lot more detail about
LL | | /// how the thing works, possibly with doclinks and so one,
LL | | /// and probably spanning a many rows.
LL | | /// and probably spanning a many rows. Blablabla, it needs to be over
LL | | /// 200 characters so I needed to write something longeeeeeeer.
| |_
|
= note: `-D clippy::too-long-first-doc-paragraph` implied by `-D warnings`

View file

@ -19,7 +19,7 @@ impl Bar {}
/// Nunc turpis nunc, lacinia
/// a dolor in, pellentesque aliquet enim. Cras nec maximus sem. Mauris arcu libero,
/// gravida non lacinia at, rhoncus eu lacus.
enum Enum {
pub enum Enum {
A,
}
@ -27,7 +27,7 @@ enum Enum {
/// ipsum dolor sit amet, consectetur adipiscing elit. Nunc turpis nunc, lacinia
/// a dolor in, pellentesque aliquet enim. Cras nec maximus sem. Mauris arcu libero,
/// gravida non lacinia at, rhoncus eu lacus.
union Union {
pub union Union {
a: u8,
b: u8,
}
@ -37,11 +37,17 @@ union Union {
/// Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc turpis nunc, lacinia
/// a dolor in, pellentesque aliquet enim. Cras nec maximus sem. Mauris arcu libero,
/// gravida non lacinia at, rhoncus eu lacus.
union Union2 {
pub union Union2 {
a: u8,
b: u8,
}
// Should not warn! (not public)
/// Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc turpis nunc, lacinia
/// a dolor in, pellentesque aliquet enim. Cras nec maximus sem. Mauris arcu libero,
/// gravida non lacinia at, rhoncus eu lacus.
fn f() {}
fn main() {
// test code goes here
}