From 608e63a5bc9375475c7c1ab5d5f0bc5b12971423 Mon Sep 17 00:00:00 2001 From: Michael Dorst Date: Wed, 29 Dec 2021 17:52:42 +0000 Subject: [PATCH] Fix `doc_markdown` lints in `bevy_audio` (#3469) #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_audio` crate. --- crates/bevy_audio/src/audio_output.rs | 2 +- crates/bevy_audio/src/audio_source.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/crates/bevy_audio/src/audio_output.rs b/crates/bevy_audio/src/audio_output.rs index 7b4aa1d24b..404c388021 100644 --- a/crates/bevy_audio/src/audio_output.rs +++ b/crates/bevy_audio/src/audio_output.rs @@ -68,7 +68,7 @@ where } } -/// Plays audio currently queued in the [Audio] resource through the [AudioOutput] resource +/// Plays audio currently queued in the [`Audio`] resource through the [`AudioOutput`] resource pub fn play_queued_audio_system(world: &mut World) where P: Decodable, diff --git a/crates/bevy_audio/src/audio_source.rs b/crates/bevy_audio/src/audio_source.rs index 8b982cdfb5..0aa9d95f18 100644 --- a/crates/bevy_audio/src/audio_source.rs +++ b/crates/bevy_audio/src/audio_source.rs @@ -17,7 +17,7 @@ impl AsRef<[u8]> for AudioSource { } } -/// Loads mp3 files as [AudioSource] [Assets](bevy_asset::Assets) +/// Loads mp3 files as [`AudioSource`] [`Assets`](bevy_asset::Assets) #[derive(Default)] pub struct Mp3Loader;