Skip to content

Commit eb558de

Browse files
jonathanc-nalamb
andauthored
minor: Update HOWTO to help with updating new docs (#13172)
* update docs * small fix * Update docs/source/contributor-guide/howtos.md * Update docs/source/contributor-guide/howtos.md --------- Co-authored-by: Andrew Lamb <[email protected]>
1 parent d36c229 commit eb558de

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/source/contributor-guide/howtos.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ Below is a checklist of what you need to do to add a new scalar function to Data
4545
- In [sqllogictest/test_files], add new `sqllogictest` integration tests where the function is called through SQL against well known data and returns the expected result.
4646
- Documentation for `sqllogictest` [here](https://github.com/apache/datafusion/blob/main/datafusion/sqllogictest/README.md)
4747
- Add SQL reference documentation [here](https://github.com/apache/datafusion/blob/main/docs/source/user-guide/sql/scalar_functions.md)
48+
- An example of this being done can be seen [here](https://github.com/apache/datafusion/pull/12775)
49+
- Run `./dev/update_function_docs.sh` to update docs
4850

4951
[advanced_udf.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/advanced_udaf.rs
5052
[sqllogictest/test_files]: https://github.com/apache/datafusion/tree/main/datafusion/sqllogictest/test_files
@@ -64,6 +66,8 @@ Below is a checklist of what you need to do to add a new aggregate function to D
6466
- In [sqllogictest/test_files], add new `sqllogictest` integration tests where the function is called through SQL against well known data and returns the expected result.
6567
- Documentation for `sqllogictest` [here](https://github.com/apache/datafusion/blob/main/datafusion/sqllogictest/README.md)
6668
- Add SQL reference documentation [here](https://github.com/apache/datafusion/blob/main/docs/source/user-guide/sql/aggregate_functions.md)
69+
- An example of this being done can be seen [here](https://github.com/apache/datafusion/pull/12775)
70+
- Run `./dev/update_function_docs.sh` to update docs
6771

6872
## How to display plans graphically
6973

0 commit comments

Comments
 (0)