Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2025-02-16 22:18:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix formatting in Name docs (#7384)

Browse source 
# Objective

There's no period at the end of the first line of the `Name` documentation, and this messes up the grammar of the summary rustdoc creates:
```
                                                                          ↓
Component used to identify an entity. Stores a hash for faster comparisons The hash is eagerly re-computed upon each update to the name.
```

## Solution

I added it.
This commit is contained in:
wackbyte 2023-01-27 17:49:11 +00:00
parent 3281aea5c2
commit 0ff839be1d
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
crates/bevy_core/src/name.rs
View file

@ -8,7 +8,8 @@ use std::{
ops::Deref, ops::Deref,
}; };
/// Component used to identify an entity. Stores a hash for faster comparisons /// Component used to identify an entity. Stores a hash for faster comparisons.
///
/// The hash is eagerly re-computed upon each update to the name. /// The hash is eagerly re-computed upon each update to the name.
/// ///
/// [`Name`] should not be treated as a globally unique identifier for entities, /// [`Name`] should not be treated as a globally unique identifier for entities,