Skip to content

Commit 668caa9

Browse files
AudaciousAxiomAudaciousAxiom
committed
doc_paragraphs_missing_punctuation: rename the lint
1 parent 76fb0ce commit 668caa9

9 files changed

+78
-78
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6224,7 +6224,7 @@ Released 2018-09-13
62246224
[`diverging_sub_expression`]: https://rust-lang.github.io/rust-clippy/master/index.html#diverging_sub_expression
62256225
[`doc_broken_link`]: https://rust-lang.github.io/rust-clippy/master/index.html#doc_broken_link
62266226
[`doc_comment_double_space_linebreaks`]: https://rust-lang.github.io/rust-clippy/master/index.html#doc_comment_double_space_linebreaks
6227-
[`doc_comments_missing_terminal_punctuation`]: https://rust-lang.github.io/rust-clippy/master/index.html#doc_comments_missing_terminal_punctuation
6227+
[`doc_paragraphs_missing_punctuation`]: https://rust-lang.github.io/rust-clippy/master/index.html#doc_paragraphs_missing_punctuation
62286228
[`doc_include_without_cfg`]: https://rust-lang.github.io/rust-clippy/master/index.html#doc_include_without_cfg
62296229
[`doc_lazy_continuation`]: https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
62306230
[`doc_link_code`]: https://rust-lang.github.io/rust-clippy/master/index.html#doc_link_code

‎clippy_lints/src/declared_lints.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ pub static LINTS: &[&::declare_clippy_lint::LintInfo] = &[
110110
crate::disallowed_script_idents::DISALLOWED_SCRIPT_IDENTS_INFO,
111111
crate::disallowed_types::DISALLOWED_TYPES_INFO,
112112
crate::doc::DOC_BROKEN_LINK_INFO,
113-
crate::doc::DOC_COMMENTS_MISSING_TERMINAL_PUNCTUATION_INFO,
113+
crate::doc::DOC_PARAGRAPHS_MISSING_PUNCTUATION_INFO,
114114
crate::doc::DOC_COMMENT_DOUBLE_SPACE_LINEBREAKS_INFO,
115115
crate::doc::DOC_INCLUDE_WITHOUT_CFG_INFO,
116116
crate::doc::DOC_LAZY_CONTINUATION_INFO,

‎clippy_lints/src/doc/doc_comments_missing_terminal_punctuation.rs‎ renamed to ‎clippy_lints/src/doc/doc_paragraphs_missing_punctuation.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use rustc_resolve::rustdoc::main_body_opts;
44

55
use rustc_resolve::rustdoc::pulldown_cmark::{Event, Options, Parser, Tag, TagEnd};
66

7-
use super::{DOC_COMMENTS_MISSING_TERMINAL_PUNCTUATION, Fragments};
7+
use super::{DOC_PARAGRAPHS_MISSING_PUNCTUATION, Fragments};
88

99
const MSG: &str = "doc comments should end with a terminal punctuation mark";
1010
const PUNCTUATION_SUGGESTION: char = '.';
@@ -17,7 +17,7 @@ pub fn check(cx: &LateContext<'_>, doc: &str, fragments: Fragments<'_>) {
1717
if let Some(span) = fragments.span(cx, offset..offset) {
1818
clippy_utils::diagnostics::span_lint_and_sugg(
1919
cx,
20-
DOC_COMMENTS_MISSING_TERMINAL_PUNCTUATION,
20+
DOC_PARAGRAPHS_MISSING_PUNCTUATION,
2121
span,
2222
MSG,
2323
"end the doc comment with some punctuation",
@@ -31,7 +31,7 @@ pub fn check(cx: &LateContext<'_>, doc: &str, fragments: Fragments<'_>) {
3131
if let Some(span) = fragments.span(cx, offset..offset) {
3232
clippy_utils::diagnostics::span_lint_and_help(
3333
cx,
34-
DOC_COMMENTS_MISSING_TERMINAL_PUNCTUATION,
34+
DOC_PARAGRAPHS_MISSING_PUNCTUATION,
3535
span,
3636
MSG,
3737
None,

‎clippy_lints/src/doc/mod.rs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ use url::Url;
2828

2929
mod broken_link;
3030
mod doc_comment_double_space_linebreaks;
31-
mod doc_comments_missing_terminal_punctuation;
31+
mod doc_paragraphs_missing_punctuation;
3232
mod doc_suspicious_footnotes;
3333
mod include_in_doc_without_cfg;
3434
mod lazy_continuation;
@@ -693,7 +693,7 @@ declare_clippy_lint! {
693693
/// /// It was chosen by a fair dice roll.
694694
/// ```
695695
#[clippy::version = "1.92.0"]
696-
pub DOC_COMMENTS_MISSING_TERMINAL_PUNCTUATION,
696+
pub DOC_PARAGRAPHS_MISSING_PUNCTUATION,
697697
nursery,
698698
"missing terminal punctuation in doc comments"
699699
}
@@ -732,7 +732,7 @@ impl_lint_pass!(Documentation => [
732732
DOC_INCLUDE_WITHOUT_CFG,
733733
DOC_COMMENT_DOUBLE_SPACE_LINEBREAKS,
734734
DOC_SUSPICIOUS_FOOTNOTES,
735-
DOC_COMMENTS_MISSING_TERMINAL_PUNCTUATION,
735+
DOC_PARAGRAPHS_MISSING_PUNCTUATION,
736736
]);
737737

738738
impl EarlyLintPass for Documentation {
@@ -904,7 +904,7 @@ fn check_attrs(cx: &LateContext<'_>, valid_idents: &FxHashSet<String>, attrs: &[
904904
},
905905
);
906906

907-
doc_comments_missing_terminal_punctuation::check(
907+
doc_paragraphs_missing_punctuation::check(
908908
cx,
909909
&doc,
910910
Fragments {

‎tests/ui/doc/doc_comments_missing_terminal_punctuation.fixed‎ renamed to ‎tests/ui/doc/doc_paragraphs_missing_punctuation.fixed‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
#![feature(custom_inner_attributes)]
22
#![rustfmt::skip]
3-
#![warn(clippy::doc_comments_missing_terminal_punctuation)]
3+
#![warn(clippy::doc_paragraphs_missing_punctuation)]
44

55
/// Returns the Answer to the Ultimate Question of Life, the Universe, and Everything.
6-
//~^ doc_comments_missing_terminal_punctuation
6+
//~^ doc_paragraphs_missing_punctuation
77
fn answer() -> i32 {
88
42
99
}
1010

1111
/// The `Option` type.
12-
//~^ doc_comments_missing_terminal_punctuation
12+
//~^ doc_paragraphs_missing_punctuation
1313
// Triggers even in the presence of another attribute.
1414
#[derive(Debug)]
1515
enum MyOption<T> {
1616
/// No value.
17-
//~^ doc_comments_missing_terminal_punctuation
17+
//~^ doc_paragraphs_missing_punctuation
1818
None,
1919
/// Some value of type `T`.
2020
Some(T),
@@ -25,7 +25,7 @@ enum MyOption<T> {
2525
#[derive(Debug)]
2626
/// doc comment:
2727
/// only the last line triggers the lint.
28-
//~^ doc_comments_missing_terminal_punctuation
28+
//~^ doc_paragraphs_missing_punctuation
2929
enum Exceptions {
3030
/// Question marks are fine?
3131
QuestionMark,
@@ -38,7 +38,7 @@ enum Exceptions {
3838
RawHtml,
3939
/// The raw HTML exception actually does the right thing to autolinks:
4040
/// <https://spec.commonmark.org/0.31.2/#autolinks>.
41-
//~^ doc_comments_missing_terminal_punctuation
41+
//~^ doc_paragraphs_missing_punctuation
4242
MarkdownAutolink,
4343
/// This table introduction ends with a colon:
4444
///
@@ -47,7 +47,7 @@ enum Exceptions {
4747
/// | Markdown table | A-ok |
4848
MarkdownTable,
4949
/// Here is a snippet.
50-
//~^ doc_comments_missing_terminal_punctuation
50+
//~^ doc_paragraphs_missing_punctuation
5151
///
5252
/// ```
5353
/// // Code blocks are no issues.
@@ -56,7 +56,7 @@ enum Exceptions {
5656
}
5757

5858
// Check the lint can be expected on a whole enum at once.
59-
#[expect(clippy::doc_comments_missing_terminal_punctuation)]
59+
#[expect(clippy::doc_paragraphs_missing_punctuation)]
6060
enum Char {
6161
/// U+0000
6262
Null,
@@ -66,18 +66,18 @@ enum Char {
6666

6767
// Check the lint can be expected on a single variant without affecting others.
6868
enum Char2 {
69-
#[expect(clippy::doc_comments_missing_terminal_punctuation)]
69+
#[expect(clippy::doc_paragraphs_missing_punctuation)]
7070
/// U+0000
7171
Null,
7272
/// U+0001.
73-
//~^ doc_comments_missing_terminal_punctuation
73+
//~^ doc_paragraphs_missing_punctuation
7474
StartOfHeading,
7575
}
7676

7777
mod module {
7878
//! Works on
7979
//! inner attributes too.
80-
//~^ doc_comments_missing_terminal_punctuation
80+
//~^ doc_paragraphs_missing_punctuation
8181
}
8282

8383
enum Trailers {
@@ -88,12 +88,12 @@ enum Trailers {
8888
/// **Sometimes the last sentence is in bold, and that's ok.**
8989
DoubleStarPassing,
9090
/// **But sometimes it is missing a period.**
91-
//~^ doc_comments_missing_terminal_punctuation
91+
//~^ doc_paragraphs_missing_punctuation
9292
DoubleStarFailing,
9393
/// _Sometimes the last sentence is in italics, and that's ok._
9494
UnderscorePassing,
9595
/// _But sometimes it is missing a period._
96-
//~^ doc_comments_missing_terminal_punctuation
96+
//~^ doc_paragraphs_missing_punctuation
9797
UnderscoreFailing,
9898
/// This comment ends with "a quote."
9999
AmericanStyleQuotePassing,
@@ -102,11 +102,11 @@ enum Trailers {
102102
}
103103

104104
/// Doc comments can end with an [inline link](#anchor).
105-
//~^ doc_comments_missing_terminal_punctuation
105+
//~^ doc_paragraphs_missing_punctuation
106106
struct InlineLink;
107107

108108
/// Some doc comments contain [link reference definitions][spec].
109-
//~^ doc_comments_missing_terminal_punctuation
109+
//~^ doc_paragraphs_missing_punctuation
110110
///
111111
/// [spec]: https://spec.commonmark.org/0.31.2/#link-reference-definitions
112112
struct LinkRefDefinition;
@@ -131,27 +131,27 @@ enum OrderedLists {
131131
}
132132

133133
/// Doc comments with trailing blank lines are supported.
134-
//~^ doc_comments_missing_terminal_punctuation
134+
//~^ doc_paragraphs_missing_punctuation
135135
///
136136
struct TrailingBlankLine;
137137

138138
/// This doc comment has multiple paragraph.
139139
/// This first paragraph is missing punctuation.
140-
//~^ doc_comments_missing_terminal_punctuation
140+
//~^ doc_paragraphs_missing_punctuation
141141
///
142142
/// The second one as well
143143
/// And it has multiple sentences.
144-
//~^ doc_comments_missing_terminal_punctuation
144+
//~^ doc_paragraphs_missing_punctuation
145145
///
146146
/// Same for this third and last one.
147-
//~^ doc_comments_missing_terminal_punctuation
147+
//~^ doc_paragraphs_missing_punctuation
148148
struct MultiParagraphDocComment;
149149

150150
/// ```
151151
struct IncompleteBlockCode;
152152

153153
/// This ends with a code `span`.
154-
//~^ doc_comments_missing_terminal_punctuation
154+
//~^ doc_paragraphs_missing_punctuation
155155
struct CodeSpan;
156156

157157
#[expect(clippy::empty_docs)]
@@ -162,7 +162,7 @@ struct EmptyDocComment;
162162
* Block doc comments work.
163163
*
164164
*/
165-
//~^^^ doc_comments_missing_terminal_punctuation
165+
//~^^^ doc_paragraphs_missing_punctuation
166166
struct BlockDocComment;
167167

168168
/// Sometimes a doc attribute is used for concatenation

‎tests/ui/doc/doc_comments_missing_terminal_punctuation.rs‎ renamed to ‎tests/ui/doc/doc_paragraphs_missing_punctuation.rs‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
#![feature(custom_inner_attributes)]
22
#![rustfmt::skip]
3-
#![warn(clippy::doc_comments_missing_terminal_punctuation)]
3+
#![warn(clippy::doc_paragraphs_missing_punctuation)]
44

55
/// Returns the Answer to the Ultimate Question of Life, the Universe, and Everything
6-
//~^ doc_comments_missing_terminal_punctuation
6+
//~^ doc_paragraphs_missing_punctuation
77
fn answer() -> i32 {
88
42
99
}
1010

1111
/// The `Option` type
12-
//~^ doc_comments_missing_terminal_punctuation
12+
//~^ doc_paragraphs_missing_punctuation
1313
// Triggers even in the presence of another attribute.
1414
#[derive(Debug)]
1515
enum MyOption<T> {
1616
/// No value
17-
//~^ doc_comments_missing_terminal_punctuation
17+
//~^ doc_paragraphs_missing_punctuation
1818
None,
1919
/// Some value of type `T`.
2020
Some(T),
@@ -25,7 +25,7 @@ enum MyOption<T> {
2525
#[derive(Debug)]
2626
/// doc comment:
2727
/// only the last line triggers the lint
28-
//~^ doc_comments_missing_terminal_punctuation
28+
//~^ doc_paragraphs_missing_punctuation
2929
enum Exceptions {
3030
/// Question marks are fine?
3131
QuestionMark,
@@ -38,7 +38,7 @@ enum Exceptions {
3838
RawHtml,
3939
/// The raw HTML exception actually does the right thing to autolinks:
4040
/// <https://spec.commonmark.org/0.31.2/#autolinks>
41-
//~^ doc_comments_missing_terminal_punctuation
41+
//~^ doc_paragraphs_missing_punctuation
4242
MarkdownAutolink,
4343
/// This table introduction ends with a colon:
4444
///
@@ -47,7 +47,7 @@ enum Exceptions {
4747
/// | Markdown table | A-ok |
4848
MarkdownTable,
4949
/// Here is a snippet
50-
//~^ doc_comments_missing_terminal_punctuation
50+
//~^ doc_paragraphs_missing_punctuation
5151
///
5252
/// ```
5353
/// // Code blocks are no issues.
@@ -56,7 +56,7 @@ enum Exceptions {
5656
}
5757

5858
// Check the lint can be expected on a whole enum at once.
59-
#[expect(clippy::doc_comments_missing_terminal_punctuation)]
59+
#[expect(clippy::doc_paragraphs_missing_punctuation)]
6060
enum Char {
6161
/// U+0000
6262
Null,
@@ -66,18 +66,18 @@ enum Char {
6666

6767
// Check the lint can be expected on a single variant without affecting others.
6868
enum Char2 {
69-
#[expect(clippy::doc_comments_missing_terminal_punctuation)]
69+
#[expect(clippy::doc_paragraphs_missing_punctuation)]
7070
/// U+0000
7171
Null,
7272
/// U+0001
73-
//~^ doc_comments_missing_terminal_punctuation
73+
//~^ doc_paragraphs_missing_punctuation
7474
StartOfHeading,
7575
}
7676

7777
mod module {
7878
//! Works on
7979
//! inner attributes too
80-
//~^ doc_comments_missing_terminal_punctuation
80+
//~^ doc_paragraphs_missing_punctuation
8181
}
8282

8383
enum Trailers {
@@ -88,12 +88,12 @@ enum Trailers {
8888
/// **Sometimes the last sentence is in bold, and that's ok.**
8989
DoubleStarPassing,
9090
/// **But sometimes it is missing a period**
91-
//~^ doc_comments_missing_terminal_punctuation
91+
//~^ doc_paragraphs_missing_punctuation
9292
DoubleStarFailing,
9393
/// _Sometimes the last sentence is in italics, and that's ok._
9494
UnderscorePassing,
9595
/// _But sometimes it is missing a period_
96-
//~^ doc_comments_missing_terminal_punctuation
96+
//~^ doc_paragraphs_missing_punctuation
9797
UnderscoreFailing,
9898
/// This comment ends with "a quote."
9999
AmericanStyleQuotePassing,
@@ -102,11 +102,11 @@ enum Trailers {
102102
}
103103

104104
/// Doc comments can end with an [inline link](#anchor)
105-
//~^ doc_comments_missing_terminal_punctuation
105+
//~^ doc_paragraphs_missing_punctuation
106106
struct InlineLink;
107107

108108
/// Some doc comments contain [link reference definitions][spec]
109-
//~^ doc_comments_missing_terminal_punctuation
109+
//~^ doc_paragraphs_missing_punctuation
110110
///
111111
/// [spec]: https://spec.commonmark.org/0.31.2/#link-reference-definitions
112112
struct LinkRefDefinition;
@@ -131,27 +131,27 @@ enum OrderedLists {
131131
}
132132

133133
/// Doc comments with trailing blank lines are supported
134-
//~^ doc_comments_missing_terminal_punctuation
134+
//~^ doc_paragraphs_missing_punctuation
135135
///
136136
struct TrailingBlankLine;
137137

138138
/// This doc comment has multiple paragraph.
139139
/// This first paragraph is missing punctuation
140-
//~^ doc_comments_missing_terminal_punctuation
140+
//~^ doc_paragraphs_missing_punctuation
141141
///
142142
/// The second one as well
143143
/// And it has multiple sentences
144-
//~^ doc_comments_missing_terminal_punctuation
144+
//~^ doc_paragraphs_missing_punctuation
145145
///
146146
/// Same for this third and last one
147-
//~^ doc_comments_missing_terminal_punctuation
147+
//~^ doc_paragraphs_missing_punctuation
148148
struct MultiParagraphDocComment;
149149

150150
/// ```
151151
struct IncompleteBlockCode;
152152

153153
/// This ends with a code `span`
154-
//~^ doc_comments_missing_terminal_punctuation
154+
//~^ doc_paragraphs_missing_punctuation
155155
struct CodeSpan;
156156

157157
#[expect(clippy::empty_docs)]
@@ -162,7 +162,7 @@ struct EmptyDocComment;
162162
* Block doc comments work
163163
*
164164
*/
165-
//~^^^ doc_comments_missing_terminal_punctuation
165+
//~^^^ doc_paragraphs_missing_punctuation
166166
struct BlockDocComment;
167167

168168
/// Sometimes a doc attribute is used for concatenation

0 commit comments

Comments
 (0)