docs(udf): how to generate udf documents (udfs_8h.md)

[aceforeverd]

Uncompleted.

• add the document for the second task in ci: add workflow for documents #1707 : udf doc gen
  • there needed extra code to make steps work
• also to metion feat: generate udf doc for RegisterAlias as well #807, which related to linked udf doc problems

[codecov]

Codecov Report

Merging #2379 (e0b0c79) into main (a6f5118) will increase coverage by 0.02%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #2379      +/-   ##
============================================
+ Coverage     75.90%   75.92%   +0.02%     
  Complexity      368      368              
============================================
  Files           629      629              
  Lines        119721   119721              
  Branches       1044     1044              
============================================
+ Hits          90874    90898      +24     
+ Misses        28631    28607      -24     
  Partials        216      216              

Impacted Files	Coverage Δ
...ridse/src/udf/default_defs/window_functions_def.cc	73.91% <ø> (ø)
hybridse/src/udf/default_udf_library.cc	96.97% <ø> (ø)
src/storage/aggregator.cc	78.40% <0.00%> (-1.24%)	⬇️
hybridse/src/codec/fe_row_codec.cc	78.68% <0.00%> (-0.16%)	⬇️
src/storage/mem_table.cc	90.10% <0.00%> (-0.15%)	⬇️
hybridse/src/vm/runner.cc	68.10% <0.00%> (-0.04%)	⬇️
src/tablet/tablet_impl.cc	61.65% <0.00%> (-0.03%)	⬇️
src/nameserver/name_server_impl.cc	42.82% <0.00%> (+0.15%)	⬆️
src/zk/dist_lock.cc	83.33% <0.00%> (+1.51%)	⬆️
src/base/file_util.h	80.74% <0.00%> (+1.60%)	⬆️
... and 5 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[github-actions]

HybridSE Linux Test Report

19 669 tests   19 667 ✔️  6m 22s ⏱️
     237 suites           2 💤
       67 files             0 ❌

Results for commit e0b0c79.

♻️ This comment has been updated with latest results.

[github-actions]

HybridSE Mac Test Report

19 669 tests   19 667 ✔️  7m 11s ⏱️
     237 suites           2 💤
       67 files             0 ❌

Results for commit e0b0c79.

♻️ This comment has been updated with latest results.

[github-actions]

Linux Test Report

       55 files       200 suites   55m 10s ⏱️
  9 755 tests   9 748 ✔️ 7 💤 0 ❌
14 356 runs  14 349 ✔️ 7 💤 0 ❌

Results for commit e0b0c79.

♻️ This comment has been updated with latest results.

[github-actions]

SDK Test Report

  79 files    79 suites   7m 45s ⏱️
167 tests 165 ✔️ 2 💤 0 ❌
209 runs  207 ✔️ 2 💤 0 ❌

Results for commit e0b0c79.

♻️ This comment has been updated with latest results.

[aceforeverd]

merge after #2382

[lumianph]

help review this pr in the pr meeting @zhanghaohit @vagetablechicken

[aceforeverd]

PR has reviewed this morning. Now it is necessary to review the changes of udf documents. It added new udf functions, and fixed many syntax errors.

[zhanghaohit]

@aceforeverd if we have multiple RegisterExternal, e.g., RegisterExternal("ilike_match"), it seems that it only extracts the first doc and totally ignoring the later docs with same udf name?

[aceforeverd]

@aceforeverd if we have multiple RegisterExternal, e.g., RegisterExternal("ilike_match"), it seems that it only extracts the first doc and totally ignoring the later docs with same udf name?

Mostly, yes, .doc string is missing for the second and later, except Supported Types includes all overloads.
It should be issue to export_udf_info or export_udf_doc.py, I'll track it elsewhere.

[zhanghaohit]

LGTM