From a23e44662e2c5ee144ed4ee1af6a0a0981556fe7 Mon Sep 17 00:00:00 2001 From: Michael Dorst Date: Tue, 28 Dec 2021 19:24:39 -0800 Subject: [PATCH] Fix doc_markdown lints in bevy_utils --- crates/bevy_utils/src/lib.rs | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/crates/bevy_utils/src/lib.rs b/crates/bevy_utils/src/lib.rs index 175152e84f2d0..eeb0ba668311d 100644 --- a/crates/bevy_utils/src/lib.rs +++ b/crates/bevy_utils/src/lib.rs @@ -32,10 +32,10 @@ impl std::hash::BuildHasher for FixedState { } } -/// A [`HashMap`][std::collections::HashMap] implementing [aHash][aHash], a high +/// A [`HashMap`][std::collections::HashMap] implementing [`aHash`], a high /// speed keyed hashing algorithm intended for use in in-memory hashmaps. /// -/// AHash is designed for performance and is NOT cryptographically secure. +/// `aHash` is designed for performance and is NOT cryptographically secure. /// /// # Construction /// @@ -68,7 +68,7 @@ impl std::hash::BuildHasher for FixedState { /// # } /// ``` /// -/// [aHash]: https://github.com/tkaitchuck/aHash +/// [`aHash`]: https://github.com/tkaitchuck/aHash pub type HashMap = std::collections::HashMap; pub trait AHashExt { @@ -76,7 +76,7 @@ pub trait AHashExt { } impl AHashExt for HashMap { - /// Creates an empty `HashMap` with the specified capacity with AHash. + /// Creates an empty `HashMap` with the specified capacity with aHash. /// /// The hash map will be able to hold at least `capacity` elements without /// reallocating. If `capacity` is 0, the hash map will not allocate. @@ -94,17 +94,17 @@ impl AHashExt for HashMap { } } -/// A stable std hash map implementing AHash, a high speed keyed hashing algorithm +/// A stable std hash map implementing `aHash`, a high speed keyed hashing algorithm /// intended for use in in-memory hashmaps. /// /// Unlike [`HashMap`] this has an iteration order that only depends on the order /// of insertions and deletions and not a random source. /// -/// AHash is designed for performance and is NOT cryptographically secure. +/// `aHash` is designed for performance and is NOT cryptographically secure. pub type StableHashMap = std::collections::HashMap; impl AHashExt for StableHashMap { - /// Creates an empty `StableHashMap` with the specified capacity with AHash. + /// Creates an empty `StableHashMap` with the specified capacity with `aHash`. /// /// The hash map will be able to hold at least `capacity` elements without /// reallocating. If `capacity` is 0, the hash map will not allocate. @@ -122,10 +122,10 @@ impl AHashExt for StableHashMap { } } -/// A [`HashSet`][std::collections::HashSet] implementing [aHash][aHash], a high +/// A [`HashSet`][std::collections::HashSet] implementing [`aHash`], a high /// speed keyed hashing algorithm intended for use in in-memory hashmaps. /// -/// AHash is designed for performance and is NOT cryptographically secure. +/// `aHash` is designed for performance and is NOT cryptographically secure. /// /// # Construction /// @@ -158,11 +158,11 @@ impl AHashExt for StableHashMap { /// # } /// ``` /// -/// [aHash]: https://github.com/tkaitchuck/aHash +/// [`aHash`]: https://github.com/tkaitchuck/aHash pub type HashSet = std::collections::HashSet; impl AHashExt for HashSet { - /// Creates an empty `HashSet` with the specified capacity with AHash. + /// Creates an empty `HashSet` with the specified capacity with aHash. /// /// The hash set will be able to hold at least `capacity` elements without /// reallocating. If `capacity` is 0, the hash set will not allocate. @@ -180,17 +180,17 @@ impl AHashExt for HashSet { } } -/// A stable std hash set implementing AHash, a high speed keyed hashing algorithm +/// A stable std hash set implementing `aHash`, a high speed keyed hashing algorithm /// intended for use in in-memory hashmaps. /// /// Unlike [`HashSet`] this has an iteration order that only depends on the order /// of insertions and deletions and not a random source. /// -/// AHash is designed for performance and is NOT cryptographically secure. +/// `aHash` is designed for performance and is NOT cryptographically secure. pub type StableHashSet = std::collections::HashSet; impl AHashExt for StableHashSet { - /// Creates an empty `StableHashSet` with the specified capacity with AHash. + /// Creates an empty `StableHashSet` with the specified capacity with `aHash`. /// /// The hash set will be able to hold at least `capacity` elements without /// reallocating. If `capacity` is 0, the hash set will not allocate.