Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jseldess opened this issue Feb 26, 2020 · 6 comments
Open

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

jseldess opened this issue Feb 26, 2020 · 6 comments
Labels
A-docs C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) E-easy Easy issue to tackle, requires little or no CockroachDB experience good first issue

Comments

@jseldess
Copy link
Contributor

jseldess commented Feb 26, 2020

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

@knz knz added A-docs C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) E-easy Easy issue to tackle, requires little or no CockroachDB experience good first issue labels Feb 26, 2020
@rdtr
Copy link

rdtr commented Mar 2, 2020

Hi,

I'm new to CRDB and looking for something to contribute, so I may be wrong but don't we handle "SKIP DOC" and "unimplemented" already here ?

Or somehow we want to apply "unimplemented" to skip each Item level in Expressions instead of skipping the whole Expression?

@jseldess
Copy link
Contributor Author

jseldess commented Apr 2, 2020

@knz, can you chime in here?

@github-actions
Copy link

We have marked this issue as stale because it has been inactive for
18 months. If this issue is still relevant, removing the stale label
or adding a comment will keep it active. Otherwise, we'll close it in
10 days to keep the issue queue tidy. Thank you for your contribution
to CockroachDB!

@jseldess
Copy link
Contributor Author

This is still relevant.

@ravikanthdba
Copy link

Hi I'm new to Cockroach DB, and was looking to contribute to open source here, so I see this as "Closed", is this issue still open?

@knz
Copy link
Contributor

knz commented May 16, 2023

it is still open.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) E-easy Easy issue to tackle, requires little or no CockroachDB experience good first issue
Projects
None yet
Development

No branches or pull requests

4 participants