4paradigm/OpenMLDB

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

Ouverte

#2 740 ouverte le 31 oct. 2022

Voir sur GitHubGuide contributeur
 (6 commentaires) (0 réaction) (1 personne assignée)C++ (329 forks)github user discovery
documentationenhancementgood first issue

Métriques du dépôt

Stars
 (1 687 étoiles)
Métriques de merge PR
 (Merge moyen 25j 1h) (5 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Recherchez les UDF avec plusieurs chaînes de documentation dans hybridse/src/udf/default udf library.cc et les fichiers similaires, puis fusionnez chacune en une seule chaîne de documentation en suivant le modèle utilisé pour dayofyear.
Stack technique
Aucun
Domaine
database
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitC++
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
78