Skip to content

Commit 2ad8955

Browse files
authored
Add section to howtos.md (#14171)
1 parent 4e88a1b commit 2ad8955

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/source/contributor-guide/howtos.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,3 +146,15 @@ valid installation of [protoc] (see [installation instructions] for details).
146146

147147
[protoc]: https://github.com/protocolbuffers/protobuf#protocol-compiler-installation
148148
[installation instructions]: https://datafusion.apache.org/contributor-guide/getting_started.html#protoc-installation
149+
150+
## How to add/edit documentation for UDFs
151+
152+
Documentations for the UDF documentations are generated from code (related [github issue]). To generate markdown run `./update_function_docs.sh`.
153+
154+
This is necessary after adding new UDF implementation or modifying existing implementation which requires to update documentation.
155+
156+
```bash
157+
./dev/update_function_docs.sh
158+
```
159+
160+
[github issue]: https://github.com/apache/datafusion/issues/12740

0 commit comments

Comments
 (0)