This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 1935a5f6c8 Publish built docs triggered by
2ad89550b60442cac8d9fc15c5753f1afc6ba5ab
1935a5f6c8 is described below
commit 1935a5f6c8387f5b7b6b3fb7c96252413b8408cd
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Sun Jan 19 14:41:42 2025 +0000
Publish built docs triggered by 2ad89550b60442cac8d9fc15c5753f1afc6ba5ab
---
_sources/contributor-guide/howtos.md.txt | 12 ++++++++++++
contributor-guide/howtos.html | 13 +++++++++++++
searchindex.js | 2 +-
3 files changed, 26 insertions(+), 1 deletion(-)
diff --git a/_sources/contributor-guide/howtos.md.txt
b/_sources/contributor-guide/howtos.md.txt
index e303c2a0f0..e406804caa 100644
--- a/_sources/contributor-guide/howtos.md.txt
+++ b/_sources/contributor-guide/howtos.md.txt
@@ -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
diff --git a/contributor-guide/howtos.html b/contributor-guide/howtos.html
index bd8951ee2e..2b8afbd0e9 100644
--- a/contributor-guide/howtos.html
+++ b/contributor-guide/howtos.html
@@ -545,6 +545,11 @@
How to update protobuf/gen dependencies
</a>
</li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link"
href="#how-to-add-edit-documentation-for-udfs">
+ How to add/edit documentation for UDFs
+ </a>
+ </li>
</ul>
</nav>
@@ -724,6 +729,14 @@ valid installation of <a class="reference external"
href="https://github.com/pro
</pre></div>
</div>
</section>
+<section id="how-to-add-edit-documentation-for-udfs">
+<h2>How to add/edit documentation for UDFs<a class="headerlink"
href="#how-to-add-edit-documentation-for-udfs" title="Link to this
heading">ΒΆ</a></h2>
+<p>Documentations for the UDF documentations are generated from code (related
<a class="reference external"
href="https://github.com/apache/datafusion/issues/12740";>github issue</a>). To
generate markdown run <code class="docutils literal notranslate"><span
class="pre">./update_function_docs.sh</span></code>.</p>
+<p>This is necessary after adding new UDF implementation or modifying existing
implementation which requires to update documentation.</p>
+<div class="highlight-bash notranslate"><div
class="highlight"><pre><span></span>./dev/update_function_docs.sh
+</pre></div>
+</div>
+</section>
</section>
diff --git a/searchindex.js b/searchindex.js
index 9737977333..82aabbcb6a 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"!=": [[48, "op-neq"]], "!~": [[48,
"op-re-not-match"]], "!~*": [[48, "op-re-not-match-i"]], "!~~": [[48, "id18"]],
"!~~*": [[48, "id19"]], "#": [[48, "op-bit-xor"]], "%": [[48, "op-modulo"]],
"&": [[48, "op-bit-and"]], "(relation, name) tuples in logical fields and
logical columns are unique": [[9,
"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]], "*":
[[48, "op-multiply"]], "+": [[48, "op-plus"]], "-": [[48, "op-minus"]], "/":
[[4 [...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"!=": [[48, "op-neq"]], "!~": [[48,
"op-re-not-match"]], "!~*": [[48, "op-re-not-match-i"]], "!~~": [[48, "id18"]],
"!~~*": [[48, "id19"]], "#": [[48, "op-bit-xor"]], "%": [[48, "op-modulo"]],
"&": [[48, "op-bit-and"]], "(relation, name) tuples in logical fields and
logical columns are unique": [[9,
"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]], "*":
[[48, "op-multiply"]], "+": [[48, "op-plus"]], "-": [[48, "op-minus"]], "/":
[[4 [...]
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
