Apply suggestions from code review

felicitymay · hubwriter · aibaars · commit 59b6d657cca9 · 2022-11-28T15:45:05.000+01:00
Co-authored-by: hubwriter &lt;hubwriter@github.com&gt;
diff --git a/cpp/ql/lib/definitions.qll b/cpp/ql/lib/definitions.qll
@@ -13,7 +13,7 @@ import IDEContextual
  * In some cases it is preferable to modify locations (the
  * `hasLocationInfo()` predicate) so that they are short, and
  * non-overlapping with other locations that might be reported as
- * code scanning alerts in GitHub.
+ * code scanning alerts on GitHub.
  *
  * We need to give locations that may not be in the database, so
  * we use `hasLocationInfo()` rather than `getLocation()`.
diff --git a/cpp/ql/src/Likely Bugs/RedundantNullCheckSimple.ql b/cpp/ql/src/Likely Bugs/RedundantNullCheckSimple.ql
@@ -13,7 +13,7 @@
 
 /*
  * Note: this query is not assigned a precision yet because we don't want it
- * included in query suites until its performance is well understood.
+ * to be included in query suites until its performance is well understood.
  */
 
 import cpp
diff --git a/docs/codeql/writing-codeql-queries/metadata-for-codeql-queries.rst b/docs/codeql/writing-codeql-queries/metadata-for-codeql-queries.rst
@@ -40,12 +40,12 @@ The following properties are supported by all query files:
 |                       | | ``readability``         |                                                                                                                                                                                                                                                                                                                                                                       |
 |                       | | ``security``            |                                                                                                                                                                                                                                                                                                                                                                       |
 +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ``@precision``        | | ``low``                 | Indicates the percentage of query results that are true positives (as opposed to false positive results). This, along with the ``@problem.severity`` property, determines how the results are displayed in GitHub.                                                                                                                                                    |
+| ``@precision``        | | ``low``                 | Indicates the percentage of query results that are true positives (as opposed to false positive results). This, along with the ``@problem.severity`` property, determines how the results are displayed on GitHub.                                                                                                                                                    |
 |                       | | ``medium``              |                                                                                                                                                                                                                                                                                                                                                                       |
 |                       | | ``high``                |                                                                                                                                                                                                                                                                                                                                                                       |
 |                       | | ``very-high``           |                                                                                                                                                                                                                                                                                                                                                                       |
 +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ``@problem.severity`` | | ``error``               | Defines the level of severity of any alerts generated by a non-security query. This, along with the ``@precision`` property, determines how the results are displayed in GitHub.                                                                                                                                                                                      |
+| ``@problem.severity`` | | ``error``               | Defines the level of severity of any alerts generated by a non-security query. This, along with the ``@precision`` property, determines how the results are displayed on GitHub.                                                                                                                                                                                      |
 |                       | | ``warning``             |                                                                                                                                                                                                                                                                                                                                                                       |
 |                       | | ``recommendation``      |                                                                                                                                                                                                                                                                                                                                                                       |
 +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ import IDEContextual`
`13`	`13`	`* In some cases it is preferable to modify locations (the`
`14`	`14`	* `hasLocationInfo()` predicate) so that they are short, and
`15`	`15`	`* non-overlapping with other locations that might be reported as`
`16`		`- * code scanning alerts in GitHub.`
	`16`	`+ * code scanning alerts on GitHub.`
`17`	`17`	`*`
`18`	`18`	`* We need to give locations that may not be in the database, so`
`19`	`19`	* we use `hasLocationInfo()` rather than `getLocation()`.