This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 2ad89550b6 Add section to howtos.md (#14171)
2ad89550b6 is described below
commit 2ad89550b60442cac8d9fc15c5753f1afc6ba5ab
Author: Jack Park <[email protected]>
AuthorDate: Sun Jan 19 06:41:09 2025 -0800
Add section to howtos.md (#14171)
---
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 e303c2a0f0..e406804caa 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
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
