4paradigm/OpenMLDB

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

Aperta

#2740 aperta il 31 ott 2022

Vedi su GitHubGuida contributor
 (6 commenti) (0 reazioni) (1 assegnatario)C++ (329 fork)github user discovery
documentationenhancementgood first issue

Metriche repository

Star
 (1687 stelle)
Metriche merge PR
 (Merge medio 25g 1h) (5 PR mergiate in 30 g)

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 contributor

Direzione di ricerca
Cerca UDF con più stringhe di documentazione in hybridse/src/udf/default udf library.cc e file simili, quindi uniscile in una singola stringa seguendo il modello usato per dayofyear.
Tech stack
Nessuno
Dominio
database
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitC++
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
78