4paradigm / 4paradigm/OpenMLDB

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

Aberta
#2,740 6 comentários 0 reações 1 responsável Reivindicada por @aceforeverd Ver no GitHub
documentation enhancement good first issue
Linguagem predominante
C++
Estrelas
1.7k
Forks
331
Merge médio
12d 12h
PRs com merge (30d)
1

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.