4paradigm/OpenMLDB

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

Open

#2,740 opened on Oct 31, 2022

View on GitHubContributor guide
 (6 comments) (0 reactions) (1 assignee)C++ (329 forks)github user discovery
documentationenhancementgood first issue

Repository metrics

Stars
 (1,687 stars)
PR merge metrics
 (Avg merge 25d 1h) (5 merged PRs in 30d)

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

Contributor guide

Research direction
Search for UDFs with multiple doc strings in hybridse/src/udf/default udf library.cc and similar files, then merge each into a single doc string following the pattern used for dayofyear.
Tech stack
None
Domain
database
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
78