Use pseudocode to document transmute_ref
#1050
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jswrenn
force-pushed
the
doc-transmute_ref
branch
from
298f6b8
to
c2a4159
Compare
joshlf
requested changes
Mar 16, 2024
There was a problem hiding this comment.
Maybe also mention that the argument and return types are inferred from the calling context? That aspect of the behavior differs from the given function since, with a function, you can specify the types if you want. A caller might expect our macro to support some sort of type syntax akin to transmute_ref::<S, D>.
Partially addresses #1046.
jswrenn
force-pushed
the
doc-transmute_ref
branch
from
c2a4159
to
28039ce
Compare
joshlf
approved these changes
Mar 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
To my eyes, this is much more easily comprehensible at a glance than the prosaic alternative.
If this looks good to you, @joshlf, I'll apply the pattern to
transmute!andtransmute_mut!too.Partially addresses #1046.