topic Re: Is there a way to add docstring to user defined functions in databricks? in Data Engineering

Is there a way to add docstring to user defined functions in databricks?

hitesh22 — Fri, 31 Mar 2023 14:12:36 GMT

Re: Is there a way to add docstring to user defined functions in databricks?

pvignesh92 — Mon, 03 Apr 2023 07:55:38 GMT

@Hitesh Agarwal Hi. AFAIK, I don't see any examples with docstring in udf. We just add the comments using typical comment way. Is there anything in particular, you want to achieve using docstring?

Re: Is there a way to add docstring to user defined functions in databricks?

hitesh22 — Mon, 03 Apr 2023 08:07:48 GMT

@Vigneshraja Palaniraj Hi, normal VS Code we can add docstring to python code but I was unable to do the same in databricks. After the latest updates in databricks we get auto-completion feature, also, when you hover over a system defined function there's a dialog box which gives you function definition, basic info and function return type. I wanted to achieve the same with user defined functios using docstring

Re: Is there a way to add docstring to user defined functions in databricks?

pvignesh92 — Mon, 03 Apr 2023 09:37:04 GMT

Hi @Hitesh Agarwal Yes I get that. I don't see anything like that available yet. Let us see if any new feature is available for the same in upcoming releases.

Re: Is there a way to add docstring to user defined functions in databricks?

hitesh22 — Tue, 04 Apr 2023 05:35:14 GMT

@Debayan Mukherjee I have gone through this article and this doesn't helps as it mentions how to see docstrings for a system defined function but not how to add docstrings to user defined functions.

Re: Is there a way to add docstring to user defined functions in databricks?

Debayan — Tue, 04 Apr 2023 05:01:12 GMT

Hi, I am not sure if this helps: https://www.databricks.com/blog/2020/12/15/python-autocomplete-improvements-for-databricks-notebooks.html

Also, please tag @Debayan with your next response which will notify me. Thank you!