4paradigm / 4paradigm/OpenMLDB

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

オープン 初心者向け
#2,740 コメント 6 件 リアクション 0 件 担当者 1 名 @aceforeverd が担当を希望しています GitHub で見る
documentation enhancement good first issue
主要言語
C++
スター
1.7k
フォーク
331
平均マージ
12日 12時間
マージ済み PR(30日)
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

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Look at the UDF definitions in hybridse/src/udf/default_udf_library.cc, starting with the listed functions (ilike_match, like_match, etc.). Compare with the dayofyear implementation to see how multiple doc strings are merged. The goal is to combine all parameter type variations into a single doc string for each function, ensuring the generated documentation includes all information.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
cpp
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
静か
明瞭さ
明確に書かれている
初心者へのやさしさ
65/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。