From 31ff3d5371221865d70896753717a05dbb81ac37 Mon Sep 17 00:00:00 2001 From: Jack Park Date: Fri, 17 Jan 2025 09:12:16 -0800 Subject: [PATCH] Add section to howtos.md --- docs/source/contributor-guide/howtos.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/source/contributor-guide/howtos.md b/docs/source/contributor-guide/howtos.md index e303c2a0f07d..e406804caa44 100644 --- a/docs/source/contributor-guide/howtos.md +++ b/docs/source/contributor-guide/howtos.md @@ -146,3 +146,15 @@ valid installation of [protoc] (see [installation instructions] for details). [protoc]: https://github.com/protocolbuffers/protobuf#protocol-compiler-installation [installation instructions]: https://datafusion.apache.org/contributor-guide/getting_started.html#protoc-installation + +## How to add/edit documentation for UDFs + +Documentations for the UDF documentations are generated from code (related [github issue]). To generate markdown run `./update_function_docs.sh`. + +This is necessary after adding new UDF implementation or modifying existing implementation which requires to update documentation. + +```bash +./dev/update_function_docs.sh +``` + +[github issue]: https://github.com/apache/datafusion/issues/12740