4paradigm/OpenMLDB

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

Aberta

#2.740 aberto em 31 de out. de 2022

Ver no GitHubGuia do colaborador
 (6 comentários) (0 reação) (1 responsável)C++ (329 forks)github user discovery
documentationenhancementgood first issue

Métricas do repositório

Stars
 (1.687 estrelas)
Métricas de merge de PR
 (Mesclagem média 25d 1h) (5 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
Procure por UDFs com várias strings de documentação em hybridse/src/udf/default udf library.cc e arquivos similares, depois mescle cada uma em uma única string seguindo o padrão usado para dayofyear.
Pilha de tecnologia
None
Domain
database
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitC++
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
78