Add units/unit prefixes of frequency to doc-valid-idents #13460
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Centri3 (or someone else) some time within the next two weeks. Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (
|
rustbot
added
the
S-waiting-on-review
| @@ -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 append `ClipPy` to the default list. | |||
|
|
|||
| **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"]` | |||
| **Default Value:** `["KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "MHz", "GHz", "THz", "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"]` | |||
There was a problem hiding this comment.
Does kilohertz not come up frequently? I think having that is fine too. I'll approve these 3 for now 👍
There was a problem hiding this comment.
"kHz" does but, as it doesn't start with a capital letter, it doesn't need any special treatment for doc_markdown.
|
@bors r+ |
|
And actually yeah, putting these in |
|
☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test |
|
Thanks a lot for merging this! |
…entri3 Add 'CoAP' to doc-valid-idents CoAP is a name of a network protocol common in embedded systems; one would talk in documentation about "a CoAP server" or "a CoAP client" without referring to a specific type. This PR fixes false positives that arise from that use. changelog: [`doc_markdown`]: Add CoAP to `doc-valid-idents`. As this review is identical in structure to #13460, I'm asking for a the same reviewer (if that works): r? `@Centri3`
These units/unit prefixes often come up in the embedded world.
Should this PR also modify the
test_unitstest? It seems only concerned with data units currently; should it also test frequency units?changelog: [
doc_markdown]: Add MHz, GHz, and THz todoc-valid-idents.