Skip to content

Commit

Permalink
Add section to howtos.md (#14171)
Browse files Browse the repository at this point in the history
  • Loading branch information
xarus01 authored Jan 19, 2025
1 parent 4e88a1b commit 2ad8955
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/source/contributor-guide/howtos.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 2ad8955

Please sign in to comment.