docgen: recognize "unimplemented" as marker to ignore rules #45464
Labels
A-docs
C-enhancement
Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception)
E-easy
Easy issue to tackle, requires little or no CockroachDB experience
good first issue
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 tweakdiagrams.go
.Example: #45442
Jira issue: CRDB-5153
The text was updated successfully, but these errors were encountered: