Skip to content

docs: clarify 'query help' usage in 'Query help style guide' #3226

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

Merged
merged 3 commits into from
Apr 8, 2020

Conversation

jf205
Copy link
Contributor

@jf205 jf205 commented Apr 8, 2020

Prompted by github/vscode-codeql#326.

When talking about query help, the convention is to always refer to them by their full name 'query help files' whose extension is .qhelp. This PR updates the 'Query help style guide' to follow that convention and clears up a few other ambiguous phrases.

felicitymay
felicitymay previously approved these changes Apr 8, 2020
Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the speedy updates. I spotted a couple of places in the original text that we could do with tidying up at the same time, but your changes LGTM.

Copy link
Contributor Author

@jf205 jf205 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @felicitymay 👀

Co-Authored-By: Felicity Chapman <[email protected]>
Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry - didn't notice that I needed to reapprove

@jf205 jf205 merged commit 6b1406f into github:master Apr 8, 2020
@jf205 jf205 deleted the update-query-help-style-guide branch May 15, 2020 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants