mirror of
https://github.com/bevyengine/bevy.git
synced 2026-05-06 06:06:42 -04:00
Rewrite the reason for the clippy::doc_markdown expectation in the bevy main crate to be more accurate (#21590)
# Objective The `bevy` main crate's `lib.rs` file contains an expectation for the `clippy::doc_markdown` lint. However, it only references one of the many times that `clippy::doc_markdown` lints on that file. Many of the other `clippy::doc_markdown` instances are within the cargo features list. ## Solution Rewrite the reason for this expectation to be more clear. Additionally, mark `GameActivity` as an allowed doc ident for Clippy. ## Testing `cargo clippy` returned no errors.
This commit is contained in:
+1
-4
@@ -1,13 +1,10 @@
|
||||
doc-valid-idents = [
|
||||
"GameActivity",
|
||||
"GilRs",
|
||||
"glTF",
|
||||
"macOS",
|
||||
"NVidia",
|
||||
"OpenXR",
|
||||
"sRGB",
|
||||
"VSync",
|
||||
"WebGL2",
|
||||
"WebGPU",
|
||||
"..",
|
||||
]
|
||||
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
#![cfg_attr(docsrs, feature(doc_cfg))]
|
||||
#![expect(
|
||||
clippy::doc_markdown,
|
||||
reason = "Android GameActivity does not need to be code-formatted."
|
||||
reason = "Clippy lints for un-backticked identifiers within the cargo features list, which we don't want."
|
||||
)]
|
||||
//! [](https://bevy.org)
|
||||
//!
|
||||
|
||||
Reference in New Issue
Block a user