Add code example in CompiledRegex

jorgectf · jorgectf · commit 21e01b809fe1 · 2021-04-27T19:54:42.000+02:00
Signed-off-by: jorgectf &lt;jorgectf@protonmail.com&gt;
diff --git a/python/ql/src/experimental/semmle/python/frameworks/Stdlib.qll b/python/ql/src/experimental/semmle/python/frameworks/Stdlib.qll
@@ -48,6 +48,17 @@ private module Re {
   /**
    * A class to find `re` methods immediately executing a compiled expression by `re.compile`.
    *
+   * Given the following example:
+   *
+   * ```py
+   * pattern = re.compile(input)
+   * input.match(s)
+   * ```
+   *
+   * `patternCall` refers to `re.compile(input)`,
+   * `regexNode` refers to `input` and
+   * `this` will refer to `input.match(s)`
+   *
    * See `RegexExecutionMethods`
    *
    * See https://docs.python.org/3/library/re.html#regular-expression-objects
