search

apache / datafusion

Apache DataFusion SQL Query Engine
https://datafusion.apache.org/
Apache License 2.0
5.21k stars 957 forks source link

Refine documentation for `Transformed::{update,map,transform})_data` #10355

Closed alamb closed 2 weeks ago

alamb commented 2 weeks ago

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

Are there any user-facing changes?

Better docs, no functional changes

alamb commented 2 weeks ago

BTW These APIs are really powerful (kudos to @peter-toth ) -- it makes rewriting plans very easy

alamb commented 2 weeks ago

Thanks again @comphead