From b65a1cadb7b32fbd8849141b63ef362c53a1c9fd Mon Sep 17 00:00:00 2001 From: Michael Dorst Date: Wed, 29 Dec 2021 17:38:08 +0000 Subject: [PATCH] Fix `doc_markdown` lints in `bevy_diagnostic` (#3472) #3457 adds the `doc_markdown` clippy lint, which checks doc comments to make sure code identifiers are escaped with backticks. This causes a lot of lint errors, so this is one of a number of PR's that will fix those lint errors one crate at a time. This PR fixes lints in the `bevy_diagnostic` crate. --- crates/bevy_diagnostic/src/diagnostic.rs | 2 +- crates/bevy_diagnostic/src/log_diagnostics_plugin.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/crates/bevy_diagnostic/src/diagnostic.rs b/crates/bevy_diagnostic/src/diagnostic.rs index 7d8cfaebcacd7..90df2c41888ef 100644 --- a/crates/bevy_diagnostic/src/diagnostic.rs +++ b/crates/bevy_diagnostic/src/diagnostic.rs @@ -27,7 +27,7 @@ pub struct DiagnosticMeasurement { pub value: f64, } -/// A timeline of [DiagnosticMeasurement]s of a specific type. +/// A timeline of [`DiagnosticMeasurement`]s of a specific type. /// Diagnostic examples: frames per second, CPU usage, network latency #[derive(Debug)] pub struct Diagnostic { diff --git a/crates/bevy_diagnostic/src/log_diagnostics_plugin.rs b/crates/bevy_diagnostic/src/log_diagnostics_plugin.rs index 4eda407fab493..571b050a1d877 100644 --- a/crates/bevy_diagnostic/src/log_diagnostics_plugin.rs +++ b/crates/bevy_diagnostic/src/log_diagnostics_plugin.rs @@ -12,7 +12,7 @@ pub struct LogDiagnosticsPlugin { pub filter: Option>, } -/// State used by the [LogDiagnosticsPlugin] +/// State used by the [`LogDiagnosticsPlugin`] struct LogDiagnosticsState { timer: Timer, filter: Option>,