doc_comments_missing_terminal_punctuation: accept punctuation in quotes

Author: AudaciousAxiom

clippy_lints/src/doc/doc_comments_missing_terminal_punctuation.rs

@@ -59,11 +59,19 @@ fn is_missing_punctuation(doc_string: &str) -> Option<usize> {
             Event::InlineHtml(_) | Event::Start(Tag::Image { .. }) | Event::End(TagEnd::Image) => {
                 text_offset = None;
             },
-            Event::Code(..) | Event::Text(..) | Event::Start(Tag::Link { .. }) | Event::End(TagEnd::Link)
+            Event::Code(..) | Event::Start(Tag::Link { .. }) | Event::End(TagEnd::Link)
                 if no_report_depth == 0 && !offset.is_empty() =>
             {
                 text_offset = Some(offset.end);
             },
+            Event::Text(..) if no_report_depth == 0 && !offset.is_empty() => {
+                // American-style quotes require punctuation to be placed inside closing quotation marks.
+                if doc_string[..offset.end].trim_end().ends_with('"') {
+                    text_offset = Some(offset.end - 1);
+                } else {
+                    text_offset = Some(offset.end);
+                }
+            },
             _ => {},
         }
     }

tests/ui/doc/doc_comments_missing_terminal_punctuation.fixed

@@ -96,6 +96,11 @@ enum Trailers {
     /// _But sometimes it is missing a period._
     //~^ doc_comments_missing_terminal_punctuation
     UnderscoreFailing,
+    /// This comment ends with "a quote."
+    QuotePassing,
+    /// This comment ends with "a quote."
+    //~^ doc_comments_missing_terminal_punctuation
+    QuoteFailing,
 }
 
 /// Doc comments can end with an [inline link](#anchor).

tests/ui/doc/doc_comments_missing_terminal_punctuation.rs

@@ -96,6 +96,11 @@ enum Trailers {
     /// _But sometimes it is missing a period_
     //~^ doc_comments_missing_terminal_punctuation
     UnderscoreFailing,
+    /// This comment ends with "a quote."
+    QuotePassing,
+    /// This comment ends with "a quote"
+    //~^ doc_comments_missing_terminal_punctuation
+    QuoteFailing,
 }
 
 /// Doc comments can end with an [inline link](#anchor)

tests/ui/doc/doc_comments_missing_terminal_punctuation.stderr

@@ -68,40 +68,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:101:56
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:101:40
+   |
+LL |     /// This comment ends with "a quote"
+   |                                        ^ 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:106: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:105:65
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:110: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:130:57
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:135: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:138:30
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:143: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:145:33
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:150: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:154:27
+  --> tests/ui/doc/doc_comments_missing_terminal_punctuation.rs:159:27
    |
 LL |  * Block doc comments work
    |                           ^ help: end the doc comment with some punctuation: `.`
 
-error: aborting due to 17 previous errors
+error: aborting due to 18 previous errors