Python: Fix documentation of MultiAssignmentDefinition.indexOf

RasmusWL · RasmusWL · commit 24e9f65a2f57 · 2020-02-27T14:12:33.000+01:00
As discussed in person
diff --git a/python/ql/src/semmle/python/essa/Essa.qll b/python/ql/src/semmle/python/essa/Essa.qll
@@ -609,11 +609,7 @@ 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.
-     */
+    /** Holds if `this` has (zero-based) index `index` in `lhs`. */
     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,11 +609,7 @@ 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`	+ /** Holds if `this` has (zero-based) index `index` in `lhs`. */
`617`	`613`	`predicate indexOf(int index, SequenceNode lhs) {`
`618`	`614`	`SsaSource::multi_assignment_definition(this.getSourceVariable(), this.getDefiningNode(), index, lhs)`
`619`	`615`	`}`