Refine documentation for Transformed::{update,map,transform})_data
#10355
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
|
BTW These APIs are really powerful (kudos to @peter-toth ) -- it makes rewriting plans very easy |
comphead
reviewed
May 2, 2024
comphead
approved these changes
May 2, 2024
Co-authored-by: comphead <[email protected]>
github-actions
bot
removed
the
documentation
|
Thanks again @comphead |
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.
Which issue does this PR close?
Part of #10121
Rationale for this change
I continually get confused between when to use
Transformed::update_data,Transformed::map_data, andTransformed::transform_data-- it would be nice for the docstrings to make it clear what the usecase is for each oneWhat changes are included in this PR?
Clarify the docstrings to hopefully make it clearer what each does
Are these changes tested?
CI
Are there any user-facing changes?
Better docs, no functional changes