cockroachdb/cockroach
docgen: recognize "unimplemented" as marker to ignore rules
開放
#45,464 建立於 2020年2月26日
A-docsC-enhancementE-easygood first issue
倉庫指標
- 星標
- (32,150 顆星)
- PR 合併指標
- (平均合併 5天 4小時) (30 天內合併 26 個 PR)
描述
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