forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix dead intra links in doc on Input and Reflect (#2007)

Browse Source 
fix a few dead links

* Links in `Input` missed a refactor
* `Reflect::downcast` can't use the intra doc link format, as it's not a link to a trait function, but to a function implemented on `dyn Reflect`

noticed in https://github.com/bevyengine/bevy/pull/1781#discussion_r619777879
This commit is contained in:
François 2021-04-25 17:24:09 +00:00
parent 0a8576b710
commit fcf8fafa71
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/bevy_input/src/input.rs
View File

@ -18,7 +18,7 @@ use bevy_ecs::schedule::State;
/// but only one should react, for example in the case of triggering /// but only one should react, for example in the case of triggering
/// [`State`] change, you should consider clearing the input state, either by: /// [`State`] change, you should consider clearing the input state, either by:
/// ///
/// * Using [`Input::just_pressed_and_clear`] or [`Input::just_released_and_clear`] instead. /// * Using [`Input::clear_just_pressed`] or [`Input::clear_just_released`] instead.
/// * Calling [`Input::clear`] or [`Input::reset`] immediately after the state change. /// * Calling [`Input::clear`] or [`Input::reset`] immediately after the state change.
/// ///
/// ## Notes when adding this resource for a new input type /// ## Notes when adding this resource for a new input type

6
crates/bevy_reflect/src/reflect.rs
View File

@ -24,9 +24,9 @@ pub enum ReflectMut<'a> {
/// A reflected rust type. /// A reflected rust type.
/// ///
/// # Safety /// # Safety
/// Implementors _must_ ensure that [Reflect::any] and [Reflect::any_mut] both return the `self` /// Implementors _must_ ensure that [`Reflect::any`] and [`Reflect::any_mut`] both return the `self`
/// value passed in If this is not done, [Reflect::downcast] will be UB (and also just logically /// value passed in If this is not done, [`Reflect::downcast`](trait.Reflect.html#method.downcast)
/// broken). /// will be UB (and also just logically broken).
pub unsafe trait Reflect: Any + Send + Sync { pub unsafe trait Reflect: Any + Send + Sync {
fn type_name(&self) -> &str; fn type_name(&self) -> &str;
fn any(&self) -> &dyn Any; fn any(&self) -> &dyn Any;