cockroachdb/cockroach

docgen: recognize "unimplemented" as marker to ignore rules

Aperta

#45.464 aperta il 26 feb 2020

Vedi su GitHubGuida contributor
 (7 commenti) (0 reazioni) (0 assegnatari)Go (4124 fork)batch import
A-docsC-enhancementE-easygood first issue

Metriche repository

Star
 (32.150 stelle)
Metriche merge PR
 (Merge medio 5g 4h) (26 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina il file `diagrams.go` e la gestione del marcatore `/* SKIP DOC */` esistente nello strumento docgen. Implementa la logica per riconoscere anche "unimplemented" come marcatore per escludere le regole dai BNF generati.
Tech stack
go
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Go
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70