cockroachdb/cockroach

docgen: recognize "unimplemented" as marker to ignore rules

Open

#45,464 opened on 2020年2月26日

GitHub で見る
 (7 comments) (0 reactions) (0 assignees)Go (32,150 stars) (4,124 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Go programminggrammar parsingdocgen tool
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
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.