Edit code example in CompiledRegex

jorgectf · jorgectf · commit 213d011a8cfc · 2021-04-29T11:10:03.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
@@ -52,12 +52,13 @@ private module Re {
    *
    * ```py
    * pattern = re.compile(input)
-   * input.match(s)
+   * pattern.match(s)
    * ```
    *
-   * `patternCall` refers to `re.compile(input)`,
-   * `regexNode` refers to `input` and
-   * `this` will refer to `input.match(s)`
+   * This class will identify that `re.compile` compiles `input` and afterwards
+   * executes `re`'s `match`. As a result, `this` will refer to `pattern.match(s)`
+   * and `this.getRegexNode()` will return the node for `input` (`re.compile`'s first argument)
+   * 
    *
    * See `RegexExecutionMethods`
    *

Original file line number	Diff line number	Diff line change
`@@ -52,12 +52,13 @@ private module Re {`
`52`	`52`	`*`
`53`	`53`	* ```py
`54`	`54`	`* pattern = re.compile(input)`
`55`		`- * input.match(s)`
	`55`	`+ * pattern.match(s)`
`56`	`56`	* ```
`57`	`57`	`*`
`58`		- * `patternCall` refers to `re.compile(input)`,
`59`		- * `regexNode` refers to `input` and
`60`		- * `this` will refer to `input.match(s)`
	`58`	+ * This class will identify that `re.compile` compiles `input` and afterwards
	`59`	+ * executes `re`'s `match`. As a result, `this` will refer to `pattern.match(s)`
	`60`	+ * and `this.getRegexNode()` will return the node for `input` (`re.compile`'s first argument)
	`61`	`+ *`
`61`	`62`	`*`
`62`	`63`	* See `RegexExecutionMethods`
`63`	`64`	`*`