4paradigm / 4paradigm/OpenMLDB

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

Aperta Adatta ai principianti
#2,740 6 commenti 0 reazioni 1 assegnatario Rivendicata da @aceforeverd Vedi su GitHub
documentation enhancement good first issue
Lingua principale
C++
Stelle
1.7k
Fork
331
Merge medio
12g 12h
PR unite (30g)
1

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
cpp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Tranquilla
Chiarezza
Specificata chiaramente
Idoneità per principianti
65/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.