4paradigm/OpenMLDB

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

オープン

#2,740 opened on 2022/10/31

GitHub で見るコントリビューターガイド
 (6 件のコメント) (0 件のリアクション) (1 人の担当者)C++ (329 件のフォーク)github user discovery
documentationenhancementgood first issue

Repository metrics

Stars
 (1,687 個のスター)
PR merge metrics
 (平均マージ 25d 1h) (30d で 5 merged PRs)

説明

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

コントリビューターガイド

調査方針
hybridse/src/udf/default udf library.cc および類似ファイルで複数のドキュメント文字列を持つUDFを検索し、dayofyearで使用されているパターンに従ってそれぞれを1つのドキュメント文字列にマージします。
技術スタック
なし
領域
database
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
GitC++
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
78