Skip to content

Docs: mention lgtm in qhelp style guide#1087

Merged
rneatherway merged 2 commits intogithub:rc/1.20from
jf205:update-qhelp-style-guide
Mar 14, 2019
Merged

Docs: mention lgtm in qhelp style guide#1087
rneatherway merged 2 commits intogithub:rc/1.20from
jf205:update-qhelp-style-guide

Conversation

@jf205
Copy link
Contributor

@jf205 jf205 commented Mar 12, 2019

I guess we can mention LGTM in the Qhelp style guide here now.
@rneatherway and @mc-semmle, this relates to https://git.semmle.com/Semmle/code/pull/31056/

@mchammer01
Copy link
Contributor

mchammer01 commented Mar 12, 2019

This is technically not incorrect but custom queries can be added for a particular project in LGTM (per-project in-repo query), or for all your projects on LGTM (global custom query) so perhaps best to say something in the lines of or add a custom query to LGTM or add a custom query for analysis in LGTM. Perhaps @rneatherway will prefer a different turn of phrase.

@jf205
Copy link
Contributor Author

jf205 commented Mar 12, 2019

Good point @mc-semmle.
Perhaps links to the help would also be useful?
Per-project queries seem to be covered in this topic: https://lgtm.com/help/lgtm/about-queries#how-do-i-add-custom-queries-to-LGTM
Are global custom queries LGTM-e only?

@mchammer01
Copy link
Contributor

mchammer01 commented Mar 12, 2019

@jf205 - yes sorry, I should have said that global custom queries are LGTM Enterprise only.
And what we call custom queries in LGTM.com (there is only one type of custom query in LGTM.com) are in fact per-project custom queries in LGTM Enterprise (they are referred to as per-project queries there).
You can link to the LGTM.com topic you mention in your earlier comment or to https://lgtm.com/help/lgtm/writing-custom-queries. Depends what info you want to link to, but bear in mind this will only contain info valid for LGTM.com.

@jf205
Copy link
Contributor Author

jf205 commented Mar 13, 2019

@mc-semmle I've used one of your initial recommendations to cover both per-project and global custom queries. I think that makes the most sense.

@github github deleted a comment from mc Mar 13, 2019
Copy link
Contributor

@mchammer01 mchammer01 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 changes @jf205 - LGTM

@jf205
Copy link
Contributor Author

jf205 commented Mar 14, 2019

@rneatherway are you happy to merge this?

@rneatherway rneatherway merged commit 6453b05 into github:rc/1.20 Mar 14, 2019
@jf205 jf205 deleted the update-qhelp-style-guide branch July 25, 2019 08:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants