doc_comments_missing_terminal_punctuation: remove the parens special treatment

AudaciousAxiom · AudaciousAxiom · commit 70a7dd679fcb · 2025-09-30T18:17:20.000+02:00
diff --git a/clippy_lints/src/doc/doc_comments_missing_terminal_punctuation.rs b/clippy_lints/src/doc/doc_comments_missing_terminal_punctuation.rs
@@ -27,8 +27,7 @@ pub fn check(cx: &LateContext<'_>, doc: &str, fragments: Fragments<'_>) {
 }
 
 #[must_use]
-/// If punctuation is missing, returns the docstring and the offset
-/// where new punctuation should be inserted.
+/// If punctuation is missing, returns the offset where new punctuation should be inserted.
 fn is_missing_punctuation(doc_string: &str) -> Option<usize> {
     const TERMINAL_PUNCTUATION_MARKS: &[char] = &['.', '?', '!', '…'];
 
@@ -63,19 +62,19 @@ fn is_missing_punctuation(doc_string: &str) -> Option<usize> {
             Event::Code(..) | Event::Text(..) | Event::Start(Tag::Link { .. }) | Event::End(TagEnd::Link)
                 if no_report_depth == 0 && !offset.is_empty() =>
             {
-                text_offset = Some(offset);
+                text_offset = Some(offset.end);
             },
             _ => {},
         }
     }
 
     let text_offset = text_offset?;
-    if doc_string[..text_offset.end]
-        .trim_end_matches(|c: char| c.is_whitespace() || c == ')' || c == ']' || c == '}')
+    if doc_string[..text_offset]
+        .trim_end()
         .ends_with(TERMINAL_PUNCTUATION_MARKS)
     {
         None
     } else {
-        Some(text_offset.end)
+        Some(text_offset)
     }
 }
diff --git a/tests/ui/doc/doc_comments_missing_terminal_punctuation.fixed b/tests/ui/doc/doc_comments_missing_terminal_punctuation.fixed
@@ -80,9 +80,10 @@ mod module {
 }
 
 enum Trailers {
-    /// (Sometimes the last sentence is in parentheses, and that's ok.)
-    ParensPassing,
-    /// (But sometimes it is missing a period).
+    /// Sometimes the doc comment ends with parentheses (like this).
+    //~^ doc_comments_missing_terminal_punctuation
+    EndsWithParens,
+    /// (Sometimes the last sentence is in parentheses, but there is no special treatment of this.).
     //~^ doc_comments_missing_terminal_punctuation
     ParensFailing,
     /// **Sometimes the last sentence is in bold, and that's ok.**
diff --git a/tests/ui/doc/doc_comments_missing_terminal_punctuation.rs b/tests/ui/doc/doc_comments_missing_terminal_punctuation.rs
@@ -80,9 +80,10 @@ mod module {
 }
 
 enum Trailers {
-    /// (Sometimes the last sentence is in parentheses, and that's ok.)
-    ParensPassing,
-    /// (But sometimes it is missing a period)
+    /// Sometimes the doc comment ends with parentheses (like this)
+    //~^ doc_comments_missing_terminal_punctuation
+    EndsWithParens,
+    /// (Sometimes the last sentence is in parentheses, but there is no special treatment of this.)
     //~^ doc_comments_missing_terminal_punctuation
     ParensFailing,
     /// **Sometimes the last sentence is in bold, and that's ok.**
diff --git a/tests/ui/doc/doc_comments_missing_terminal_punctuation.stderr b/tests/ui/doc/doc_comments_missing_terminal_punctuation.stderr
@@ -44,58 +44,64 @@ LL |     //! inner attributes too
    |                             ^ help: end the doc comment with some punctuation: `.`
 
 error: doc comments should end with a terminal punctuation mark
-  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:85:47
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:83:68
    |
-LL |     /// (But sometimes it is missing a period)
-   |                                               ^ help: end the doc comment with some punctuation: `.`
+LL |     /// Sometimes the doc comment ends with parentheses (like this)
+   |                                                                    ^ help: end the doc comment with some punctuation: `.`
+
+error: doc comments should end with a terminal punctuation mark
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:86:100
+   |
+LL |     /// (Sometimes the last sentence is in parentheses, but there is no special treatment of this.)
+   |                                                                                                    ^ help: end the doc comment with some punctuation: `.`
 
 error: doc comments should end with a terminal punctuation mark
-  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:90:47
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:91:47
    |
 LL |     /// **But sometimes it is missing a period**
    |                                               ^ help: end the doc comment with some punctuation: `.`
 
 error: doc comments should end with a terminal punctuation mark
-  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:95:46
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:96:46
    |
 LL |     /// _But sometimes it is missing a period_
    |                                              ^ help: end the doc comment with some punctuation: `.`
 
 error: doc comments should end with a terminal punctuation mark
-  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:100:56
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:101:56
    |
 LL | /// Doc comments can end with an [inline link](#anchor)
    |                                                        ^ help: end the doc comment with some punctuation: `.`
 
 error: doc comments should end with a terminal punctuation mark
-  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:104:65
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:105:65
    |
 LL | /// Some doc comments contain [link reference definitions][spec]
    |                                                                 ^ help: end the doc comment with some punctuation: `.`
 
 error: doc comments should end with a terminal punctuation mark
-  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:129:57
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:130:57
    |
 LL | /// Doc comments with trailing blank lines are supported
    |                                                         ^ help: end the doc comment with some punctuation: `.`
 
 error: doc comments should end with a terminal punctuation mark
-  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:137:30
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:138:30
    |
 LL | /// Only the last sentence is
    |                              ^ help: end the doc comment with some punctuation: `.`
 
 error: doc comments should end with a terminal punctuation mark
-  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:144:33
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:145:33
    |
 LL | /// This ends with a code `span`
    |                                 ^ help: end the doc comment with some punctuation: `.`
 
 error: doc comments should end with a terminal punctuation mark
-  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:153:27
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:154:27
    |
 LL |  * Block doc comments work
    |                           ^ help: end the doc comment with some punctuation: `.`
 
-error: aborting due to 16 previous errors
+error: aborting due to 17 previous errors
 

Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,7 @@ pub fn check(cx: &LateContext<'_>, doc: &str, fragments: Fragments<'_>) {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`#[must_use]`
`30`		`-/// If punctuation is missing, returns the docstring and the offset`
`31`		`-/// where new punctuation should be inserted.`
	`30`	`+/// If punctuation is missing, returns the offset where new punctuation should be inserted.`
`32`	`31`	`fn is_missing_punctuation(doc_string: &str) -> Option<usize> {`
`33`	`32`	`const TERMINAL_PUNCTUATION_MARKS: &[char] = &['.', '?', '!', '…'];`
`34`	`33`
`@@ -63,19 +62,19 @@ fn is_missing_punctuation(doc_string: &str) -> Option<usize> {`
`63`	`62`	`Event::Code(..) \| Event::Text(..) \| Event::Start(Tag::Link { .. }) \| Event::End(TagEnd::Link)`
`64`	`63`	`if no_report_depth == 0 && !offset.is_empty() =>`
`65`	`64`	`{`
`66`		`- text_offset = Some(offset);`
	`65`	`+ text_offset = Some(offset.end);`
`67`	`66`	`},`
`68`	`67`	`_ => {},`
`69`	`68`	`}`
`70`	`69`	`}`
`71`	`70`
`72`	`71`	`let text_offset = text_offset?;`
`73`		`- if doc_string[..text_offset.end]`
`74`		`- .trim_end_matches(\|c: char\| c.is_whitespace() \|\| c == ')' \|\| c == ']' \|\| c == '}')`
	`72`	`+ if doc_string[..text_offset]`
	`73`	`+ .trim_end()`
`75`	`74`	`.ends_with(TERMINAL_PUNCTUATION_MARKS)`
`76`	`75`	`{`
`77`	`76`	`None`
`78`	`77`	`} else {`
`79`		`- Some(text_offset.end)`
	`78`	`+ Some(text_offset)`
`80`	`79`	`}`
`81`	`80`	`}`