cockroachdb/cockroach

docgen: recognize "unimplemented" as marker to ignore rules

Open

#45,464 opened on Feb 26, 2020

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Go (4,124 forks)batch import
A-docsC-enhancementE-easygood first issue

Repository metrics

Stars
 (32,150 stars)
PR merge metrics
 (Avg merge 5d 4h) (26 merged PRs in 30d)

Description

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

Research direction
Examine the `diagrams.go` file and the existing `/* SKIP DOC */` marker handling in the docgen tool. Implement logic to also recognize "unimplemented" as a marker to exclude rules from generated BNFs.
Tech stack
go
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70