From 612731edfbaedc700352ab6c513f0123c10ba9c2 Mon Sep 17 00:00:00 2001 From: Wybe Westra Date: Tue, 17 Sep 2024 21:27:26 +0200 Subject: [PATCH] Add `DynamicTyped` link to `TypeInfo` docs (#15188) (#15259) Also added a bit to the paragraph to explain when to use the new function. Fixes #15188. --- crates/bevy_reflect/src/type_info.rs | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/crates/bevy_reflect/src/type_info.rs b/crates/bevy_reflect/src/type_info.rs index 1d98b14b0e..bc1ef1ef12 100644 --- a/crates/bevy_reflect/src/type_info.rs +++ b/crates/bevy_reflect/src/type_info.rs @@ -172,15 +172,17 @@ pub enum TypeInfoError { /// 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`] -/// 2. [`PartialReflect::get_represented_type_info`] -/// 3. [`TypeRegistry::get_type_info`] +/// 2. [`DynamicTyped::reflect_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. /// 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 /// [`TypeRegistry::get_type_info`]. ///