alamb opened a new pull request, #10355:
URL: https://github.com/apache/datafusion/pull/10355

   ## 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`, and `Transformed::transform_data` -- it would be nice 
for the docstrings to make it clear what the usecase is for each one
   
   ## What changes are included in this PR?
   Clarify the docstrings to hopefully make it clearer what each does
   
   ## Are these changes tested?
   CI
   <!--
   We typically require tests for all PRs in order to:
   1. Prevent the code from being accidentally broken by subsequent changes
   2. Serve as another way to document the expected behavior of the code
   
   If tests are not included in your PR, please explain why (for example, are 
they covered by existing tests)?
   -->
   
   ## Are there any user-facing changes?
   Better docs, no functional changes
   <!--
   If there are user-facing changes then we may require documentation to be 
updated before approving the PR.
   -->
   
   <!--
   If there are any breaking changes to public APIs, please add the `api 
change` label.
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org
For additional commands, e-mail: github-h...@datafusion.apache.org

Reply via email to