4paradigm/OpenMLDB

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

开放

#2,740 创建于 2022年10月31日

 (6 条评论) (0 个反应) (1 位负责人)C++ (329 个派生)github user discovery
documentationenhancementgood first issue

仓库指标

星标
 (1,687 个星标)
PR 合并指标
 (平均合并 25天 1小时) (30 天内合并 5 个 PR)

描述

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

贡献者指南