Skip to content

Commit 771a2a9

Browse files
committed
Auto merge of rust-lang#11926 - edmorley:update-default-doc_valid_idents, r=blyxyas
Add "OpenTelemetry" to default `doc_valid_idents` The OpenTelemetry project's name is all one word (see https://opentelemetry.io), so currently triggers a false positive in the `doc_markdown` lint. The project is increasing rapidly in popularity, so it seems like a worthy contender for inclusion in the default `doc_valid_idents` configuration. I've also moved the existing "OpenDNS" entry earlier in the list, to restore the alphabetical ordering of that "Open*" row. The docs changes were generated using `cargo collect-metadata`. changelog: [`doc_markdown`]: Add `OpenTelemetry` to the default configuration as an allowed identifier
2 parents 692f53f + a16a850 commit 771a2a9

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

book/src/lint_configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ default configuration of Clippy. By default, any configuration will replace the
212212
* `doc-valid-idents = ["ClipPy"]` would replace the default list with `["ClipPy"]`.
213213
* `doc-valid-idents = ["ClipPy", ".."]` would append `ClipPy` to the default list.
214214

215-
**Default Value:** `["KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "DirectX", "ECMAScript", "GPLv2", "GPLv3", "GitHub", "GitLab", "IPv4", "IPv6", "ClojureScript", "CoffeeScript", "JavaScript", "PureScript", "TypeScript", "WebAssembly", "NaN", "NaNs", "OAuth", "GraphQL", "OCaml", "OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap", "OpenDNS", "WebGL", "WebGL2", "WebGPU", "TensorFlow", "TrueType", "iOS", "macOS", "FreeBSD", "TeX", "LaTeX", "BibTeX", "BibLaTeX", "MinGW", "CamelCase"]`
215+
**Default Value:** `["KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "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", "TensorFlow", "TrueType", "iOS", "macOS", "FreeBSD", "TeX", "LaTeX", "BibTeX", "BibLaTeX", "MinGW", "CamelCase"]`
216216

217217
---
218218
**Affected lints:**

clippy_config/src/conf.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const DEFAULT_DOC_VALID_IDENTS: &[&str] = &[
2626
"NaN", "NaNs",
2727
"OAuth", "GraphQL",
2828
"OCaml",
29-
"OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap", "OpenDNS",
29+
"OpenDNS", "OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap", "OpenTelemetry",
3030
"WebGL", "WebGL2", "WebGPU",
3131
"TensorFlow",
3232
"TrueType",

tests/ui/doc/doc-fixable.fixed

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ fn test_units() {
6464
/// NaN NaNs
6565
/// OAuth GraphQL
6666
/// OCaml
67-
/// OpenGL OpenMP OpenSSH OpenSSL OpenStreetMap OpenDNS
67+
/// OpenDNS OpenGL OpenMP OpenSSH OpenSSL OpenStreetMap OpenTelemetry
6868
/// WebGL WebGL2 WebGPU
6969
/// TensorFlow
7070
/// TrueType

tests/ui/doc/doc-fixable.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ fn test_units() {
6464
/// NaN NaNs
6565
/// OAuth GraphQL
6666
/// OCaml
67-
/// OpenGL OpenMP OpenSSH OpenSSL OpenStreetMap OpenDNS
67+
/// OpenDNS OpenGL OpenMP OpenSSH OpenSSL OpenStreetMap OpenTelemetry
6868
/// WebGL WebGL2 WebGPU
6969
/// TensorFlow
7070
/// TrueType

0 commit comments

Comments
 (0)