Python: Document MultiAssignmentDefinition.indexOf

RasmusWL · RasmusWL · commit 4433cc044d72 · 2020-02-27T13:48:43.000+01:00
diff --git a/python/ql/src/semmle/python/essa/Essa.qll b/python/ql/src/semmle/python/essa/Essa.qll
@@ -609,6 +609,11 @@ class MultiAssignmentDefinition extends EssaNodeDefinition {
         )
     }
 
+    /**
+     * Holds if `this` has index `index` in `lhs`.
+     *
+     * For example, for `a,b = t` the call `b.indexOf(1, t)` holds.
+     */
     predicate indexOf(int index, SequenceNode lhs) {
         SsaSource::multi_assignment_definition(this.getSourceVariable(), this.getDefiningNode(), index, lhs)
     }

Original file line number	Diff line number	Diff line change
`@@ -609,6 +609,11 @@ class MultiAssignmentDefinition extends EssaNodeDefinition {`
`609`	`609`	`)`
`610`	`610`	`}`
`611`	`611`
	`612`	`+ /**`
	`613`	+ * Holds if `this` has index `index` in `lhs`.
	`614`	`+ *`
	`615`	+ * For example, for `a,b = t` the call `b.indexOf(1, t)` holds.
	`616`	`+ */`
`612`	`617`	`predicate indexOf(int index, SequenceNode lhs) {`
`613`	`618`	`SsaSource::multi_assignment_definition(this.getSourceVariable(), this.getDefiningNode(), index, lhs)`
`614`	`619`	`}`