cockroachdb/cockroach

docgen: recognize "unimplemented" as marker to ignore rules

Open

#45.464 geöffnet am 26. Feb. 2020

Auf GitHub ansehen
 (7 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (32.150 Stars) (4.124 Forks)batch import
A-docsC-enhancementE-easygood first issue

Beschreibung

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

Contributor Guide

Tech Stack
gosql
Domain
documentation
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Go programminggrammar parsingdocgen tool
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65
Research-Richtung
Examine the existing docgen code that processes grammar markers like 'SKIP DOC' (likely in a file like `cmd/docgen/main.go` or similar). The linked PR (#45442) may provide an example of similar changes. Implement logic to detect 'unimplemented' in the grammar and skip generating diagrams for those rules. Ensure the change is consistent with the current skipping mechanism.