docgen: recognize "unimplemented" as marker to ignore rules · cockroachdb/cockroach#45464

(7 评论) (0 反应) (0 负责人)Go (32,150 star) (4,124 fork)batch import

A-docsC-enhancementE-easygood 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 tweak diagrams.go.

Example: https://github.com/cockroachdb/cockroach/pull/45442

Jira issue: CRDB-5153

贡献者指南

技术栈: gosql
领域: documentation
议题类型: feature
难度: 3
预计时间: half day
活动状态: stale
清晰度: clear
前置要求: Go programminggrammar parsingdocgen tool
新手友好度: 65
研究方向: 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.