bevy_reflect: Rename UntypedReflectDeserializer
to ReflectDeserializer
#12721
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
We have
ReflectSerializer
andTypedReflectSerializer
. The former is the one users will most often use since the latter takes a bit more effort to deserialize.However, our deserializers are named
UntypedReflectDeserializer
andTypedReflectDeserializer
. There is no obvious indication thatUntypedReflectDeserializer
must be used withReflectSerializer
since the names don't quite match up.Solution
Rename
UntypedReflectDeserializer
back toReflectDeserializer
(initially changed as part of #5723).Also update the docs for both deserializers (as they were pretty out of date) and include doc examples.
I also updated the docs for the serializers, too, just so that everything is consistent.
Changelog
UntypedReflectDeserializer
toReflectDeserializer
ReflectDeserializer
,TypedReflectDeserializer
,ReflectSerializer
, andTypedReflectSerializer
Migration Guide
UntypedReflectDeserializer
has been renamed toReflectDeserializer
. Usages will need to be updated accordingly.