ibis-project / ibis

the portable Python dataframe library
https://ibis-project.org
Apache License 2.0
4.3k stars 537 forks source link

docs(udfs): improve udf docstring examples #9079

Closed gforsyth closed 2 weeks ago

gforsyth commented 2 weeks ago

UDF arguments need to be Ibis expressions. In the existing docstring examples for the UDF decorators, it can be unclear that the integers being passed to add_one are implicitly converted to Ibis literals.

To make it clearer, I've added memtables to all the examples, and used pandas- and pyarrow-specific functions to the examples.

gforsyth commented 2 weeks ago

xref #9069