DOC: User Guide Page on user-defined functions #61195
Conversation
|
Currently writing this, so I would appreciate any feedback on it! |
There was a problem hiding this comment.
Thanks for the PR! I'm not opposed to a dedicated page on UDFs, but I am opposed to duplicating documentation that exists elsewhere in the user guide, as I think much of this does. Instead of e.g. examples of apply, I recommend linking to the appropriate section. This page can then focus on recommendations of when to use apply vs other methods.
| Why Use User-Defined Functions? | ||
| ------------------------------- |
There was a problem hiding this comment.
I think we should lead with Why _not_ User-Defined Functions. While performance is called out down below, I think the poor behavior of UDFs should be mentioned as well. Namely that pandas has no information on what a UDF is doing, and so has to infer (guess) at how to handle the result.
In particular, I think it should be mentioned that none of the examples on this page should be UDFs in practice.
|
Hi @rhshadrach thanks for the feedback! I agree with you and will push updates soon |
Tests added and passed if fixing a bug or adding a new featureAll code checks passed.Added type annotations to new arguments/methods/functions.Added an entry in the latestdoc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.