Skip to content

Commit 4d381c3

Browse files
committed
Auto merge of rust-lang#6605 - kawogi:doc-markdown, r=llogiq
Doc markdown I added "WebGL" along the lines of the existing "OpenGL" to the whitelist of `doc_markdown` as I found this to be a pretty common term. (this is a follow-up of the now closed rust-lang/rust-clippy#6388) changelog: Whitelist "WebGL" in `doc_markdown`.
2 parents a982ab4 + c3244c2 commit 4d381c3

File tree

3 files changed

+24
-22
lines changed

3 files changed

+24
-22
lines changed

clippy_lints/src/utils/conf.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ define_Conf! {
127127
"OAuth", "GraphQL",
128128
"OCaml",
129129
"OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap",
130+
"WebGL",
130131
"TensorFlow",
131132
"TrueType",
132133
"iOS", "macOS",

tests/ui/doc.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ fn test_units() {
5353
/// DirectX
5454
/// ECMAScript
5555
/// OAuth GraphQL
56+
/// WebGL
5657
/// TeX LaTeX BibTeX BibLaTeX
5758
/// CamelCase (see also #2395)
5859
/// be_sure_we_got_to_the_end_of_it

tests/ui/doc.stderr

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -55,133 +55,133 @@ LL | /// be_sure_we_got_to_the_end_of_it
5555
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5656

5757
error: you should put `be_sure_we_got_to_the_end_of_it` between ticks in the documentation
58-
--> $DIR/doc.rs:58:5
58+
--> $DIR/doc.rs:59:5
5959
|
6060
LL | /// be_sure_we_got_to_the_end_of_it
6161
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6262

6363
error: you should put `link_with_underscores` between ticks in the documentation
64-
--> $DIR/doc.rs:62:22
64+
--> $DIR/doc.rs:63:22
6565
|
6666
LL | /// This test has [a link_with_underscores][chunked-example] inside it. See #823.
6767
| ^^^^^^^^^^^^^^^^^^^^^
6868

6969
error: you should put `inline_link2` between ticks in the documentation
70-
--> $DIR/doc.rs:65:21
70+
--> $DIR/doc.rs:66:21
7171
|
7272
LL | /// It can also be [inline_link2].
7373
| ^^^^^^^^^^^^
7474

7575
error: you should put `be_sure_we_got_to_the_end_of_it` between ticks in the documentation
76-
--> $DIR/doc.rs:75:5
76+
--> $DIR/doc.rs:76:5
7777
|
7878
LL | /// be_sure_we_got_to_the_end_of_it
7979
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8080

8181
error: you should put `CamelCaseThing` between ticks in the documentation
82-
--> $DIR/doc.rs:83:8
82+
--> $DIR/doc.rs:84:8
8383
|
8484
LL | /// ## CamelCaseThing
8585
| ^^^^^^^^^^^^^^
8686

8787
error: you should put `CamelCaseThing` between ticks in the documentation
88-
--> $DIR/doc.rs:86:7
88+
--> $DIR/doc.rs:87:7
8989
|
9090
LL | /// # CamelCaseThing
9191
| ^^^^^^^^^^^^^^
9292

9393
error: you should put `CamelCaseThing` between ticks in the documentation
94-
--> $DIR/doc.rs:88:22
94+
--> $DIR/doc.rs:89:22
9595
|
9696
LL | /// Not a title #897 CamelCaseThing
9797
| ^^^^^^^^^^^^^^
9898

9999
error: you should put `be_sure_we_got_to_the_end_of_it` between ticks in the documentation
100-
--> $DIR/doc.rs:89:5
100+
--> $DIR/doc.rs:90:5
101101
|
102102
LL | /// be_sure_we_got_to_the_end_of_it
103103
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
104104

105105
error: you should put `be_sure_we_got_to_the_end_of_it` between ticks in the documentation
106-
--> $DIR/doc.rs:96:5
106+
--> $DIR/doc.rs:97:5
107107
|
108108
LL | /// be_sure_we_got_to_the_end_of_it
109109
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
110110

111111
error: you should put `be_sure_we_got_to_the_end_of_it` between ticks in the documentation
112-
--> $DIR/doc.rs:109:5
112+
--> $DIR/doc.rs:110:5
113113
|
114114
LL | /// be_sure_we_got_to_the_end_of_it
115115
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
116116

117117
error: you should put `FooBar` between ticks in the documentation
118-
--> $DIR/doc.rs:120:43
118+
--> $DIR/doc.rs:121:43
119119
|
120120
LL | /** E.g., serialization of an empty list: FooBar
121121
| ^^^^^^
122122

123123
error: you should put `BarQuz` between ticks in the documentation
124-
--> $DIR/doc.rs:125:5
124+
--> $DIR/doc.rs:126:5
125125
|
126126
LL | And BarQuz too.
127127
| ^^^^^^
128128

129129
error: you should put `be_sure_we_got_to_the_end_of_it` between ticks in the documentation
130-
--> $DIR/doc.rs:126:1
130+
--> $DIR/doc.rs:127:1
131131
|
132132
LL | be_sure_we_got_to_the_end_of_it
133133
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
134134

135135
error: you should put `FooBar` between ticks in the documentation
136-
--> $DIR/doc.rs:131:43
136+
--> $DIR/doc.rs:132:43
137137
|
138138
LL | /** E.g., serialization of an empty list: FooBar
139139
| ^^^^^^
140140

141141
error: you should put `BarQuz` between ticks in the documentation
142-
--> $DIR/doc.rs:136:5
142+
--> $DIR/doc.rs:137:5
143143
|
144144
LL | And BarQuz too.
145145
| ^^^^^^
146146

147147
error: you should put `be_sure_we_got_to_the_end_of_it` between ticks in the documentation
148-
--> $DIR/doc.rs:137:1
148+
--> $DIR/doc.rs:138:1
149149
|
150150
LL | be_sure_we_got_to_the_end_of_it
151151
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
152152

153153
error: you should put `be_sure_we_got_to_the_end_of_it` between ticks in the documentation
154-
--> $DIR/doc.rs:148:5
154+
--> $DIR/doc.rs:149:5
155155
|
156156
LL | /// be_sure_we_got_to_the_end_of_it
157157
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
158158

159159
error: you should put bare URLs between `<`/`>` or make a proper Markdown link
160-
--> $DIR/doc.rs:175:13
160+
--> $DIR/doc.rs:176:13
161161
|
162162
LL | /// Not ok: http://www.unicode.org
163163
| ^^^^^^^^^^^^^^^^^^^^^^
164164

165165
error: you should put bare URLs between `<`/`>` or make a proper Markdown link
166-
--> $DIR/doc.rs:176:13
166+
--> $DIR/doc.rs:177:13
167167
|
168168
LL | /// Not ok: https://www.unicode.org
169169
| ^^^^^^^^^^^^^^^^^^^^^^^
170170

171171
error: you should put bare URLs between `<`/`>` or make a proper Markdown link
172-
--> $DIR/doc.rs:177:13
172+
--> $DIR/doc.rs:178:13
173173
|
174174
LL | /// Not ok: http://www.unicode.org/
175175
| ^^^^^^^^^^^^^^^^^^^^^^
176176

177177
error: you should put bare URLs between `<`/`>` or make a proper Markdown link
178-
--> $DIR/doc.rs:178:13
178+
--> $DIR/doc.rs:179:13
179179
|
180180
LL | /// Not ok: http://www.unicode.org/reports/tr9/#Reordering_Resolved_Levels
181181
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
182182

183183
error: you should put `mycrate::Collection` between ticks in the documentation
184-
--> $DIR/doc.rs:181:22
184+
--> $DIR/doc.rs:182:22
185185
|
186186
LL | /// An iterator over mycrate::Collection's values.
187187
| ^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)