Docs: Query classification and display #3974

owen-mc · 2020-07-24T12:22:38Z

Converted from Semmle wiki

Marcono1234

Did you commit this with an e-mail address which differs from your GitHub e-mail address on purpose?

Marcono1234 · 2020-07-25T16:47:10Z

docs/query-classification-and-display.md

@@ -0,0 +1,125 @@
+# Query classification and display
+
+Attributable Queries


Should this be a sub-header?

Marcono1234 · 2020-07-25T16:48:21Z

docs/query-classification-and-display.md

+the value over (or under) the threshold. Some queries only trigger
+another one doesn't. An example of this is the MaybeNull query which


Suggested change

the value over (or under) the threshold. Some queries only trigger

another one doesn't. An example of this is the MaybeNull query which

the value over (or under) the threshold. Some queries only trigger

when another one doesn't. An example of this is the MaybeNull query which

Missing "when"?

Marcono1234 · 2020-07-25T16:48:43Z

docs/query-classification-and-display.md

+the value over (or under) the threshold. Some queries only trigger
+another one doesn't. An example of this is the MaybeNull query which
+only triggers if the AlwaysNull query doesn't. A small change in the
+data flow could make an alert switch from AlwayNull to MaybeNull (or


Suggested change

data flow could make an alert switch from AlwayNull to MaybeNull (or

data flow could make an alert switch from AlwaysNull to MaybeNull (or

Marcono1234 · 2020-07-25T16:51:40Z

docs/query-classification-and-display.md

+file" didn't. As a result adding some code to a duplicate file might
+result in a "fix" of a "duplicate file" alert and an introduction of
+many "duplicate function" alerts. This would be highly unfair.
+Currently, on the duplicate and similar code queries exhibit this


Suggested change

Currently, on the duplicate and similar code queries exhibit this

Currently, only the duplicate and similar code queries exhibit this

Marcono1234 · 2020-07-25T16:53:40Z

docs/query-classification-and-display.md

+  - Metric violations, i.e. the ones with metadata properties like ` 
+    @(error|warning|recommendation)-(to|from)  `
+  - Queries with tag `  non-attributable `
+
+`   `


Suggested change

- Metric violations, i.e. the ones with metadata properties like `

@(error|warning|recommendation)-(to|from) `

- Queries with tag ` non-attributable `

` `

- Metric violations, i.e. the ones with metadata properties like `@(error|warning|recommendation)-(to|from)`

- Queries with tag `non-attributable`

Marcono1234 · 2020-07-25T17:05:18Z

docs/query-classification-and-display.md

+made visible by editing the project configuration.
+
+
+ Queries from custom query packs (in-repo or site-wide) are always run


Suggested change

Queries from custom query packs (in-repo or site-wide) are always run

Queries from custom query packs (in-repo or site-wide) are always run

Marcono1234 · 2020-07-25T17:05:40Z

docs/query-classification-and-display.md

+
+
+ Queries from custom query packs (in-repo or site-wide) are always run
+and displayed by default. The can be hidden by editing the project


Suggested change

and displayed by default. The can be hidden by editing the project

and displayed by default. They can be hidden by editing the project

Marcono1234 · 2020-07-25T18:06:06Z

docs/query-classification-and-display.md

+
+This check is applied when the results of a single attribution are
+loaded into the datastore. This means that any change to this behaviour
+will only take effect on newly attributed revisions and the historical


Maybe use "but" instead of "and" here to clearly indicate the difference

Suggested change

will only take effect on newly attributed revisions and the historical

will only take effect on newly attributed revisions but the historical

Marcono1234 · 2020-07-25T18:07:38Z

docs/query-classification-and-display.md

+
+The following queries are excluded from attribution:
+
+  - Metric violations, i.e. the ones with metadata properties like ` 


Note that here and for the other lists the indentation is not needed

Marcono1234 · 2020-07-25T18:09:54Z

docs/query-classification-and-display.md

+
+<div class="table-wrap">
+
+| Precision:     | V. high     | High    | Medium  | Low |


"V. high" could be written out as "Very-high" since the table is not that wide.
Same applies for the other table as well.

Converted from Semmle wiki

owen-mc · 2020-07-27T09:22:08Z

Thanks for the thorough review. I must apologise - I've been doing a lot of these conversions from the Semmle wiki recently and in this I have either lost a commit somewhere or forgotten to go through and fix up the conversion errors. Also, I was using a different computer while my normal one was being fixed and I forgot to set up my name or email address in git - thanks for pointing that out.

Marcono1234

No problem. There is one more minor thing.

Marcono1234 · 2020-07-27T10:50:57Z

docs/query-classification-and-display.md

+
+For precision, we have the following categories:
+
+- Very-high


Maybe use "Very high" (without hyphen) here since the tables below use this variant as well?

Actually on closer inspection it should have the hyphen, and all of them shouldn't have a capital letter, as this is what is actually found in the query files. I've corrected this.

owen-mc · 2020-10-19T15:07:00Z

@calumgrant I had to force-push with a trivial change (extra space in a commit message) to get CI to pass. Unfortunately it dismissed your review. Can you add it back? (And feel free to merge)

owen-mc requested review from calumgrant and matt-gretton-dann July 24, 2020 12:22

Marcono1234 reviewed Jul 25, 2020

View reviewed changes

owen-mc added 2 commits July 27, 2020 10:06

Docs: Query classification and display

4094fa9

Converted from Semmle wiki

Address review comments

6dbed5e

owen-mc force-pushed the docs/query-classification-and-display branch from 8e16554 to 6dbed5e Compare July 27, 2020 09:20

Marcono1234 reviewed Jul 27, 2020

View reviewed changes

owen-mc assigned calumgrant and matt-gretton-dann Aug 12, 2020

adityasharad changed the base branch from master to main August 14, 2020 18:33

calumgrant previously approved these changes Oct 19, 2020

View reviewed changes

List precision options more accurately

77312a2

owen-mc dismissed calumgrant’s stale review via 77312a2 October 19, 2020 14:09

owen-mc force-pushed the docs/query-classification-and-display branch from 2ef0fb4 to 77312a2 Compare October 19, 2020 14:09

github-actions bot added the documentation label Oct 19, 2020

calumgrant approved these changes Oct 22, 2020

View reviewed changes

calumgrant merged commit 7544bc8 into github:main Oct 22, 2020

owen-mc deleted the docs/query-classification-and-display branch October 22, 2020 10:45

Dec	JAN	Feb
	15
2025	2026	2027

		@@ -0,0 +1,125 @@
		# Query classification and display

		Attributable Queries

		the value over (or under) the threshold. Some queries only trigger
		another one doesn't. An example of this is the MaybeNull query which

	data flow could make an alert switch from AlwayNull to MaybeNull (or
	data flow could make an alert switch from AlwaysNull to MaybeNull (or

	Currently, on the duplicate and similar code queries exhibit this
	Currently, only the duplicate and similar code queries exhibit this

		made visible by editing the project configuration.


		Queries from custom query packs (in-repo or site-wide) are always run



		Queries from custom query packs (in-repo or site-wide) are always run
		and displayed by default. The can be hidden by editing the project

	and displayed by default. The can be hidden by editing the project
	and displayed by default. They can be hidden by editing the project

	will only take effect on newly attributed revisions and the historical
	will only take effect on newly attributed revisions but the historical


		The following queries are excluded from attribution:

		- Metric violations, i.e. the ones with metadata properties like `


		<div class="table-wrap">

		\| Precision: \| V. high \| High \| Medium \| Low \|

Docs: Query classification and display #3974

Docs: Query classification and display #3974

Uh oh!

Conversation

owen-mc commented Jul 24, 2020

Uh oh!

Marcono1234 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

owen-mc commented Jul 27, 2020

Uh oh!

Marcono1234 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

owen-mc commented Oct 19, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants