Skip to content

docgen: recognize "unimplemented" as marker to ignore rules #45464

@jseldess

Description

@jseldess

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: #45442

Jira issue: CRDB-5153

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsC-enhancementSolution expected to add code/behavior + preserve backward-compat (pg compat issues are exception)E-easyEasy issue to tackle, requires little or no CockroachDB experiencegood first issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions