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

Add DynamicTyped link to TypeInfo docs (#15188) (#15259)

Browse Source 
Also added a bit to the paragraph to explain when to use the new
function.
Fixes #15188.
This commit is contained in:
Wybe Westra 2024-09-17 21:27:26 +02:00 committed by GitHub
parent 378dcacf82
commit 612731edfb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/bevy_reflect/src/type_info.rs
View File

@ -172,15 +172,17 @@ pub enum TypeInfoError {
/// Compile-time type information for various reflected types. /// Compile-time type information for various reflected types.
/// ///
/// Generally, for any given type, this value can be retrieved one of three ways: /// Generally, for any given type, this value can be retrieved in one of four ways:
/// ///
/// 1. [`Typed::type_info`] /// 1. [`Typed::type_info`]
/// 2. [`PartialReflect::get_represented_type_info`] /// 2. [`DynamicTyped::reflect_type_info`]
/// 3. [`TypeRegistry::get_type_info`] /// 3. [`PartialReflect::get_represented_type_info`]
/// 4. [`TypeRegistry::get_type_info`]
/// ///
/// Each return a static reference to [`TypeInfo`], but they all have their own use cases. /// Each return a static reference to [`TypeInfo`], but they all have their own use cases.
/// For example, if you know the type at compile time, [`Typed::type_info`] is probably /// For example, if you know the type at compile time, [`Typed::type_info`] is probably
/// the simplest. If all you have is a `dyn PartialReflect`, you'll probably want [`PartialReflect::get_represented_type_info`]. /// the simplest. If you have a `dyn Reflect` you can use [`DynamicTyped::reflect_type_info`].
/// If all you have is a `dyn PartialReflect`, you'll probably want [`PartialReflect::get_represented_type_info`].
/// Lastly, if all you have is a [`TypeId`] or [type path], you will need to go through /// Lastly, if all you have is a [`TypeId`] or [type path], you will need to go through
/// [`TypeRegistry::get_type_info`]. /// [`TypeRegistry::get_type_info`].
/// ///