mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add more doc-valid-idents

Browse Source 
* "AccessKit" is a commonly used accessibility toolkit used in Rust GUIs.
* "CoreFoundation", "CoreGraphics", "CoreText" are frameworks on Apple OSes.
* "Direct2D", "Direct3D", "DirectWrite" are frameworks on Windows
* "PostScript" is a programming language and is mentioned when talking about
  text and vector graphics.
* "OpenAL" is an audio framework / API.
* "OpenType" is a font format (TrueType is already mentioned).
* "WebRTC", "WebSocket", "WebTransport" are web networking technologies.
* "NetBSD" and "OpenBSD" are like the already included FreeBSD.
This commit is contained in:
Bruce Mitchener 2024-07-13 15:46:52 +07:00
parent 0cbbee1e6e
commit 39378cf4f4
5 changed files with 47 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
book/src/lint_configuration.md
View File

@ -455,7 +455,7 @@ default configuration of Clippy. By default, any configuration will replace the
* `doc-valid-idents = ["ClipPy"]` would replace the default list with `["ClipPy"]`. * `doc-valid-idents = ["ClipPy"]` would replace the default list with `["ClipPy"]`.
* `doc-valid-idents = ["ClipPy", ".."]` would append `ClipPy` to the default list. * `doc-valid-idents = ["ClipPy", ".."]` would append `ClipPy` to the default list.
**Default Value:** `["KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "DevOps", "DirectX", "ECMAScript", "GPLv2", "GPLv3", "GitHub", "GitLab", "IPv4", "IPv6", "ClojureScript", "CoffeeScript", "JavaScript", "PureScript", "TypeScript", "WebAssembly", "NaN", "NaNs", "OAuth", "GraphQL", "OCaml", "OpenDNS", "OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap", "OpenTelemetry", "WebGL", "WebGL2", "WebGPU", "WebP", "OpenExr", "YCbCr", "sRGB", "TensorFlow", "TrueType", "iOS", "macOS", "FreeBSD", "TeX", "LaTeX", "BibTeX", "BibLaTeX", "MinGW", "CamelCase"]` **Default Value:** `["KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "AccessKit", "CoreFoundation", "CoreGraphics", "CoreText", "DevOps", "Direct2D", "Direct3D", "DirectWrite", "DirectX", "ECMAScript", "GPLv2", "GPLv3", "GitHub", "GitLab", "IPv4", "IPv6", "ClojureScript", "CoffeeScript", "JavaScript", "PostScript", "PureScript", "TypeScript", "WebAssembly", "NaN", "NaNs", "OAuth", "GraphQL", "OCaml", "OpenAL", "OpenDNS", "OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap", "OpenTelemetry", "OpenType", "WebGL", "WebGL2", "WebGPU", "WebRTC", "WebSocket", "WebTransport", "WebP", "OpenExr", "YCbCr", "sRGB", "TensorFlow", "TrueType", "iOS", "macOS", "FreeBSD", "NetBSD", "OpenBSD", "TeX", "LaTeX", "BibTeX", "BibLaTeX", "MinGW", "CamelCase"]`
--- ---
**Affected lints:** **Affected lints:**

13
clippy_config/src/conf.rs
View File

@ -18,23 +18,26 @@
#[rustfmt::skip] #[rustfmt::skip]
const DEFAULT_DOC_VALID_IDENTS: &[&str] = &[ const DEFAULT_DOC_VALID_IDENTS: &[&str] = &[
"KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB",
"AccessKit",
"CoreFoundation", "CoreGraphics", "CoreText",
"DevOps", "DevOps",
"DirectX", "Direct2D", "Direct3D", "DirectWrite", "DirectX",
"ECMAScript", "ECMAScript",
"GPLv2", "GPLv3", "GPLv2", "GPLv3",
"GitHub", "GitLab", "GitHub", "GitLab",
"IPv4", "IPv6", "IPv4", "IPv6",
"ClojureScript", "CoffeeScript", "JavaScript", "PureScript", "TypeScript", "ClojureScript", "CoffeeScript", "JavaScript", "PostScript", "PureScript", "TypeScript",
"WebAssembly", "WebAssembly",
"NaN", "NaNs", "NaN", "NaNs",
"OAuth", "GraphQL", "OAuth", "GraphQL",
"OCaml", "OCaml",
"OpenDNS", "OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap", "OpenTelemetry", "OpenAL", "OpenDNS", "OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap", "OpenTelemetry",
"WebGL", "WebGL2", "WebGPU", "OpenType",
"WebGL", "WebGL2", "WebGPU", "WebRTC", "WebSocket", "WebTransport",
"WebP", "OpenExr", "YCbCr", "sRGB", "WebP", "OpenExr", "YCbCr", "sRGB",
"TensorFlow", "TensorFlow",
"TrueType", "TrueType",
"iOS", "macOS", "FreeBSD", "iOS", "macOS", "FreeBSD", "NetBSD", "OpenBSD",
"TeX", "LaTeX", "BibTeX", "BibLaTeX", "TeX", "LaTeX", "BibTeX", "BibLaTeX",
"MinGW", "MinGW",
"CamelCase", "CamelCase",

13
tests/ui/doc/doc-fixable.fixed
View File

@ -54,21 +54,24 @@ fn test_units() {
/// This tests allowed identifiers. /// This tests allowed identifiers.
/// KiB MiB GiB TiB PiB EiB /// KiB MiB GiB TiB PiB EiB
/// DirectX /// AccessKit
/// CoreFoundation CoreGraphics CoreText
/// Direct2D Direct3D DirectWrite DirectX
/// ECMAScript /// ECMAScript
/// GPLv2 GPLv3 /// GPLv2 GPLv3
/// GitHub GitLab /// GitHub GitLab
/// IPv4 IPv6 /// IPv4 IPv6
/// ClojureScript CoffeeScript JavaScript PureScript TypeScript /// ClojureScript CoffeeScript JavaScript PostScript PureScript TypeScript
/// WebAssembly /// WebAssembly
/// NaN NaNs /// NaN NaNs
/// OAuth GraphQL /// OAuth GraphQL
/// OCaml /// OCaml
/// OpenDNS OpenGL OpenMP OpenSSH OpenSSL OpenStreetMap OpenTelemetry /// OpenAL OpenDNS OpenGL OpenMP OpenSSH OpenSSL OpenStreetMap OpenTelemetry
/// WebGL WebGL2 WebGPU /// OpenType
/// WebGL WebGL2 WebGPU WebRTC WebSocket WebTransport
/// TensorFlow /// TensorFlow
/// TrueType /// TrueType
/// iOS macOS FreeBSD /// iOS macOS FreeBSD NetBSD OpenBSD
/// TeX LaTeX BibTeX BibLaTeX /// TeX LaTeX BibTeX BibLaTeX
/// MinGW /// MinGW
/// CamelCase (see also #2395) /// CamelCase (see also #2395)

13
tests/ui/doc/doc-fixable.rs
View File

@ -54,21 +54,24 @@ fn test_units() {
/// This tests allowed identifiers. /// This tests allowed identifiers.
/// KiB MiB GiB TiB PiB EiB /// KiB MiB GiB TiB PiB EiB
/// DirectX /// AccessKit
/// CoreFoundation CoreGraphics CoreText
/// Direct2D Direct3D DirectWrite DirectX
/// ECMAScript /// ECMAScript
/// GPLv2 GPLv3 /// GPLv2 GPLv3
/// GitHub GitLab /// GitHub GitLab
/// IPv4 IPv6 /// IPv4 IPv6
/// ClojureScript CoffeeScript JavaScript PureScript TypeScript /// ClojureScript CoffeeScript JavaScript PostScript PureScript TypeScript
/// WebAssembly /// WebAssembly
/// NaN NaNs /// NaN NaNs
/// OAuth GraphQL /// OAuth GraphQL
/// OCaml /// OCaml
/// OpenDNS OpenGL OpenMP OpenSSH OpenSSL OpenStreetMap OpenTelemetry /// OpenAL OpenDNS OpenGL OpenMP OpenSSH OpenSSL OpenStreetMap OpenTelemetry
/// WebGL WebGL2 WebGPU /// OpenType
/// WebGL WebGL2 WebGPU WebRTC WebSocket WebTransport
/// TensorFlow /// TensorFlow
/// TrueType /// TrueType
/// iOS macOS FreeBSD /// iOS macOS FreeBSD NetBSD OpenBSD
/// TeX LaTeX BibTeX BibLaTeX /// TeX LaTeX BibTeX BibLaTeX
/// MinGW /// MinGW
/// CamelCase (see also #2395) /// CamelCase (see also #2395)

44
tests/ui/doc/doc-fixable.stderr
View File

@ -133,7 +133,7 @@ LL | /// `be_sure_we_got_to_the_end_of_it`
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:75:5 --> tests/ui/doc/doc-fixable.rs:78:5
| |
LL | /// be_sure_we_got_to_the_end_of_it LL | /// be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -144,7 +144,7 @@ LL | /// `be_sure_we_got_to_the_end_of_it`
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:92:5 --> tests/ui/doc/doc-fixable.rs:95:5
| |
LL | /// be_sure_we_got_to_the_end_of_it LL | /// be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -155,7 +155,7 @@ LL | /// `be_sure_we_got_to_the_end_of_it`
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:100:8 --> tests/ui/doc/doc-fixable.rs:103:8
| |
LL | /// ## CamelCaseThing LL | /// ## CamelCaseThing
| ^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^
@ -166,7 +166,7 @@ LL | /// ## `CamelCaseThing`
| ~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:103:7 --> tests/ui/doc/doc-fixable.rs:106:7
| |
LL | /// # CamelCaseThing LL | /// # CamelCaseThing
| ^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^
@ -177,7 +177,7 @@ LL | /// # `CamelCaseThing`
| ~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:105:22 --> tests/ui/doc/doc-fixable.rs:108:22
| |
LL | /// Not a title #897 CamelCaseThing LL | /// Not a title #897 CamelCaseThing
| ^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^
@ -188,7 +188,7 @@ LL | /// Not a title #897 `CamelCaseThing`
| ~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:106:5 --> tests/ui/doc/doc-fixable.rs:109:5
| |
LL | /// be_sure_we_got_to_the_end_of_it LL | /// be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -199,7 +199,7 @@ LL | /// `be_sure_we_got_to_the_end_of_it`
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:113:5 --> tests/ui/doc/doc-fixable.rs:116:5
| |
LL | /// be_sure_we_got_to_the_end_of_it LL | /// be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -210,7 +210,7 @@ LL | /// `be_sure_we_got_to_the_end_of_it`
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:126:5 --> tests/ui/doc/doc-fixable.rs:129:5
| |
LL | /// be_sure_we_got_to_the_end_of_it LL | /// be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -221,7 +221,7 @@ LL | /// `be_sure_we_got_to_the_end_of_it`
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:137:43 --> tests/ui/doc/doc-fixable.rs:140:43
| |
LL | /** E.g., serialization of an empty list: FooBar LL | /** E.g., serialization of an empty list: FooBar
| ^^^^^^ | ^^^^^^
@ -232,7 +232,7 @@ LL | /** E.g., serialization of an empty list: `FooBar`
| ~~~~~~~~ | ~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:142:5 --> tests/ui/doc/doc-fixable.rs:145:5
| |
LL | And BarQuz too. LL | And BarQuz too.
| ^^^^^^ | ^^^^^^
@ -243,7 +243,7 @@ LL | And `BarQuz` too.
| ~~~~~~~~ | ~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:143:1 --> tests/ui/doc/doc-fixable.rs:146:1
| |
LL | be_sure_we_got_to_the_end_of_it LL | be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -254,7 +254,7 @@ LL | `be_sure_we_got_to_the_end_of_it`
| |
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:148:43 --> tests/ui/doc/doc-fixable.rs:151:43
| |
LL | /** E.g., serialization of an empty list: FooBar LL | /** E.g., serialization of an empty list: FooBar
| ^^^^^^ | ^^^^^^
@ -265,7 +265,7 @@ LL | /** E.g., serialization of an empty list: `FooBar`
| ~~~~~~~~ | ~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:153:5 --> tests/ui/doc/doc-fixable.rs:156:5
| |
LL | And BarQuz too. LL | And BarQuz too.
| ^^^^^^ | ^^^^^^
@ -276,7 +276,7 @@ LL | And `BarQuz` too.
| ~~~~~~~~ | ~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:154:1 --> tests/ui/doc/doc-fixable.rs:157:1
| |
LL | be_sure_we_got_to_the_end_of_it LL | be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -287,7 +287,7 @@ LL | `be_sure_we_got_to_the_end_of_it`
| |
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:165:5 --> tests/ui/doc/doc-fixable.rs:168:5
| |
LL | /// be_sure_we_got_to_the_end_of_it LL | /// be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -298,7 +298,7 @@ LL | /// `be_sure_we_got_to_the_end_of_it`
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:184:22 --> tests/ui/doc/doc-fixable.rs:187:22
| |
LL | /// An iterator over mycrate::Collection's values. LL | /// An iterator over mycrate::Collection's values.
| ^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^
@ -309,7 +309,7 @@ LL | /// An iterator over `mycrate::Collection`'s values.
| ~~~~~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:208:34 --> tests/ui/doc/doc-fixable.rs:211:34
| |
LL | /// Foo \[bar\] \[baz\] \[qux\]. DocMarkdownLint LL | /// Foo \[bar\] \[baz\] \[qux\]. DocMarkdownLint
| ^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^
@ -320,7 +320,7 @@ LL | /// Foo \[bar\] \[baz\] \[qux\]. `DocMarkdownLint`
| ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:231:22 --> tests/ui/doc/doc-fixable.rs:234:22
| |
LL | /// There is no try (do() or do_not()). LL | /// There is no try (do() or do_not()).
| ^^^^ | ^^^^
@ -331,7 +331,7 @@ LL | /// There is no try (`do()` or do_not()).
| ~~~~~~ | ~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:231:30 --> tests/ui/doc/doc-fixable.rs:234:30
| |
LL | /// There is no try (do() or do_not()). LL | /// There is no try (do() or do_not()).
| ^^^^^^^^ | ^^^^^^^^
@ -342,7 +342,7 @@ LL | /// There is no try (do() or `do_not()`).
| ~~~~~~~~~~ | ~~~~~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:234:5 --> tests/ui/doc/doc-fixable.rs:237:5
| |
LL | /// ABes LL | /// ABes
| ^^^^ | ^^^^
@ -353,7 +353,7 @@ LL | /// `ABes`
| ~~~~~~ | ~~~~~~
error: item in documentation is missing backticks error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:240:9 --> tests/ui/doc/doc-fixable.rs:243:9
| |
LL | /// foo() LL | /// foo()
| ^^^^^ | ^^^^^
@ -364,7 +364,7 @@ LL | /// `foo()`
| ~~~~~~~ | ~~~~~~~
error: you should put bare URLs between `<`/`>` or make a proper Markdown link error: you should put bare URLs between `<`/`>` or make a proper Markdown link
--> tests/ui/doc/doc-fixable.rs:244:5 --> tests/ui/doc/doc-fixable.rs:247:5
| |
LL | /// https://github.com/rust-lang/rust-clippy/pull/12836 LL | /// https://github.com/rust-lang/rust-clippy/pull/12836
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `<https://github.com/rust-lang/rust-clippy/pull/12836>` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `<https://github.com/rust-lang/rust-clippy/pull/12836>`