cockroachdb/cockroach

docgen: recognize "unimplemented" as marker to ignore rules

Open

#45.464 aperta il 26 feb 2020

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

Metriche repository

Star
 (32.150 star)
Metriche merge PR
 (Merge medio 6g 6h) (611 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 codice docgen esistente che elabora marcatori grammaticali come 'SKIP DOC' (probabilmente in un file come `cmd/docgen/main.go` o simile). La PR collegata (#45442) potrebbe fornire un esempio di modifiche simili. Implementa la logica per rilevare 'unimplemented' nella grammatica e saltare la generazione di diagrammi per quelle regole. Assicurati che la modifica sia coerente con il meccanismo di salto attuale.
Tech stack
gosql
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Go programminggrammar parsingdocgen tool
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65