4paradigm / 4paradigm/OpenMLDB

doc(udf): merge udf docs for the same function

未關閉
#2,740 6 則留言 0 個 reaction 已指派 1 人 已被 @aceforeverd 認領 在 GitHub 檢視
documentation enhancement good first issue
主要語言
C++
星號
1.7k
分支
331
平均合併
12 天 12 小時
30 天內合併 PR
1

描述

some UDFs may has mutiple doc string, each for different parameters type. The problem is for udf doc gen, it is unclear which doc string to publish in the generated doc (as the document only has one entry for each, it selects random one). Refer the PR #2734 .

know problem udfs
- ilike_match
- like_match
- regexp_like
- string
- substring
- or anything else you find

**Solution**

merge the multiple doc strings into single one, with all informations included. See how dayofyear implemented: https://github.com/4paradigm/OpenMLDB/blob/c1d5e1d4e810590e678d77294774832f0ad1a394/hybridse/src/udf/default_udf_library.cc#L2178-L2210

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。