user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: too_long_first_doc_paragraph suggests wrongly when first line too long (#14276)

Browse source 
Fixes #14274

changelog: [`too_long_first_doc_paragraph`]: fix wrong suggestion when
first line too long
This commit is contained in:
Jason Newcomb 2025-02-24 10:04:01 +00:00 • committed by GitHub
commit 0fa170621d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 21 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
tests/ui/too_long_first_doc_paragraph.rs
View file

@ -61,6 +61,13 @@ pub union Union2 {
/// gravida non lacinia at, rhoncus eu lacus.
fn f() {}
#[rustfmt::skip]
/// Some function. This doc-string paragraph is too long. Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
//~^ too_long_first_doc_paragraph
///
/// Here's a second paragraph. It would be preferable to put the details here.
pub fn issue_14274() {}
fn main() {
// test code goes here
}

11
tests/ui/too_long_first_doc_paragraph.stderr
View file

@ -39,5 +39,14 @@ LL | | /// a dolor in, pellentesque aliquet enim. Cras nec maximus sem. Mauris a
LL | | /// gravida non lacinia at, rhoncus eu lacus.
| |_^
error: aborting due to 3 previous errors
error: first doc comment paragraph is too long
--> tests/ui/too_long_first_doc_paragraph.rs:65:1
|
LL | / /// Some function. This doc-string paragraph is too long. Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lore...
LL | |
LL | | ///
LL | | /// Here's a second paragraph. It would be preferable to put the details here.
| |_^
error: aborting due to 4 previous errors