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

Ruby: add an AST reference guide #11056

Open
wants to merge 5 commits into
base: codeql-cli-2.11.2
Choose a base branch
from

Conversation

alexrford
Copy link
Contributor

@alexrford alexrford commented Oct 31, 2022

Adds a reference for CodeQL Ast module classes and associated Ruby syntax.

The Ruby syntax provided is not complete. I used parse.y as a reference, and the actual syntax is very complex and not really realistic to present in a table like this. What's here should hopefully be enough to give a flavour of the kinds of expressions that map onto the provided CodeQL classes.

In some cases where it seemed clearer to do so, such as the Literals section, I've resorted to providing example expressions rather than a syntax definition. It may be that this approach would be better for some other sections as well.

@alexrford alexrford marked this pull request as ready for review Nov 1, 2022
@alexrford alexrford added the Ruby label Nov 1, 2022
@github-actions github-actions bot removed the Ruby label Nov 2, 2022
@alexrford alexrford added the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label Nov 2, 2022
@lucascosti
Copy link

lucascosti commented Nov 2, 2022

👋 Docs first responder here! I've added this to our review board for a writer to have a look at. 🙇‍♂️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. Ruby GA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants