Python: Fix grammar

Co-authored-by: Taus <[email protected]>

Author: RasmusWL

python/ql/test/experimental/library-tests/CallGraph-xfail/call_edge_xfail.py

@@ -19,7 +19,7 @@ def xfail_baz():
 else:
     func = xfail_bar
 
-# Correct usage to supres bad annotation errors
+# Correct usage to suppress bad annotation errors
 # calls:xfail_foo calls:xfail_bar
 func()
 # calls:xfail_lambda

python/ql/test/experimental/library-tests/CallGraph/CallGraphTest.qll

@@ -88,12 +88,12 @@ private newtype TCallGraphResolver =
     TPointsToResolver() or
     TTypeTrackerResolver()
 
-/** Describes a method of for call graph resolution */
+/** Describes a method of call graph resolution */
 abstract class CallGraphResolver extends TCallGraphResolver {
     abstract predicate callEdge(Call call, Function callable);
 
     /**
-     * Annotations show that `call` will call `callable`,
+     * Holds if annotations show that `call` will call `callable`,
      * but our call graph resolver was not able to figure that out
      */
     predicate expectedCallEdgeNotFound(Call call, Function callable) {
@@ -102,7 +102,7 @@ abstract class CallGraphResolver extends TCallGraphResolver {
     }
 
     /**
-     * No annotations show that `call` will call `callable` (where at least one of these are annotated),
+     * Holds if there are no annotations that show that `call` will call `callable` (where at least one of these are annotated),
      * but the call graph resolver claims that `call` will call `callable`
      */
     predicate unexpectedCallEdgeFound(Call call, Function callable, string message) {
@@ -127,6 +127,7 @@ abstract class CallGraphResolver extends TCallGraphResolver {
     string toString() { result = "CallGraphResolver" }
 }
 
+/** A call graph resolver based on the existing points-to analysis */
 class PointsToResolver extends CallGraphResolver, TPointsToResolver {
     override predicate callEdge(Call call, Function callable) {
         exists(PythonFunctionValue func_value |
@@ -137,7 +138,7 @@ class PointsToResolver extends CallGraphResolver, TPointsToResolver {
 
     override string toString() { result = "PointsToResolver" }
 }
-
+/** A call graph resolved based on Type Trackers */
 class TypeTrackerResolver extends CallGraphResolver, TTypeTrackerResolver {
     override predicate callEdge(Call call, Function callable) { none() }
 

python/ql/test/experimental/library-tests/CallGraph/README.md

@@ -12,7 +12,7 @@ foo()
 
 This is greatly inspired by [`CallGraphs/AnnotatedTest`](https://github.com/github/codeql/blob/696d19cb1440b6f6a75c6a2c1319e18860ceb436/javascript/ql/test/library-tests/CallGraphs/AnnotatedTest/Test.ql) from JavaScript.
 
-IMPORTANT: Names used in annotations are not scoped, so must be unique globally. (this is a bit annoying, but makes things simple).
+IMPORTANT: Names used in annotations are not scoped, so must be unique globally. (this is a bit annoying, but makes things simple). If multiple identical annotations are used, an error message will be output.
 
 Important files:
 
@@ -22,11 +22,11 @@ Important files:
 - `Relative.ql`: differences between using points-to and TypeTracking.
 - `code/` contains the actual Python code we test against (included by `test.py`).
 
-All queries will also execute some `debug_*` predicates, that highlights any obvious problems with the annotation setup, and there should never be any results comitted. To show that this works as expected, see the [CallGraph-xfail](../CallGraph-xfail/)  which uses symlinked versions of the files in this directory (can't include as subdir, so has to be a sibling).
+All queries will also execute some `debug_*` predicates. These highlight any obvious problems with the annotation setup, and so there should never be any results committed. To show that this works as expected, see the [CallGraph-xfail](../CallGraph-xfail/)  which uses symlinked versions of the files in this directory (can't include as subdir, so has to be a sibling).
 
 ## `options` file
 
-If the value for `--max-import-depth` is set so `import random` will extract `random.py` from the standard library, BUT NO transitive imports are extracted, then points-to analysis will fail to handle the following snippet.
+If the value for `--max-import-depth` is set so that `import random` will extract `random.py` from the standard library, BUT NO transitive imports are extracted, then points-to analysis will fail to handle the following snippet.
 
 ```py
 import random