4paradigm/OpenMLDB

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

Offen

#2.740 geöffnet am 31.10.2022

Auf GitHub ansehenContributor Guide
 (6 Kommentare) (0 Reaktionen) (1 zugewiesene Person)C++ (329 Forks)github user discovery
documentationenhancementgood first issue

Repository-Metriken

Stars
 (1.687 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 25T 1h) (5 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Suchen Sie nach UDFs mit mehreren Doc Strings in hybridse/src/udf/default udf library.cc und ähnlichen Dateien und fassen Sie diese dann zu einem einzigen Doc String zusammen, nach dem Muster, das für dayofyear verwendet wird.
Tech Stack
Keine
Domain
database
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitC++
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
78