cockroachdb/cockroach

docgen: recognize "unimplemented" as marker to ignore rules

Aberta

#45.464 aberto em 26 de fev. de 2020

Ver no GitHubGuia do colaborador
 (7 comentários) (0 reação) (0 responsável)Go (4.124 forks)batch import
A-docsC-enhancementE-easygood first issue

Métricas do repositório

Stars
 (32.150 estrelas)
Métricas de merge de PR
 (Mesclagem média 5d 4h) (26 fundiu PRs em 30d)

Description

Various aspects of our SQL grammar are marked as "unimplemented". These unimplemented features/keywords/etc. should not be included in the generated SQL diagrams we use in our docs. Currently, we must edit diagrams.go to hide unimplemented syntax from the generated bnfs that are used to genereate our SQL diagrams. Instead, it would be great if "unimplemented" were treated like /* SKIP DOC */. This would be much more efficient in that all unimplemented features would be excluded from all generated bnfs without docs writers needed to tweak diagrams.go.

Example: https://github.com/cockroachdb/cockroach/pull/45442

Jira issue: CRDB-5153

Guia do colaborador

Direção de pesquisa
Examine o arquivo `diagrams.go` e o tratamento do marcador `/* SKIP DOC */` existente na ferramenta docgen. Implemente a lógica para também reconhecer "unimplemented" como um marcador para excluir regras dos BNFs gerados.
Pilha de tecnologia
go
Domain
documentation
Tipo Issue
Funcionalidade
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.
1-3 horas
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
Go
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70