Swift: improve QLDoc for getSequence

rdmarsh2 · rdmarsh2 · commit c281db6b5b23 · 2023-10-06T15:23:58.000Z
diff --git a/swift/ql/lib/codeql/swift/elements/stmt/ForEachStmt.qll b/swift/ql/lib/codeql/swift/elements/stmt/ForEachStmt.qll
@@ -8,10 +8,8 @@ class ForEachStmt extends Generated::ForEachStmt {
   }
 
   /*
-   * Gets the sequence of this for each statement.
+   * Gets the sequence which this statement is iterating over.
    */
 
-  final Expr getSequence() {
-    result = this.getIteratorVar().getInit(0)
-  }
+  final Expr getSequence() { result = this.getIteratorVar().getInit(0) }
 }

Original file line number	Diff line number	Diff line change
`@@ -8,10 +8,8 @@ class ForEachStmt extends Generated::ForEachStmt {`
`8`	`8`	`}`
`9`	`9`
`10`	`10`	`/*`
`11`		`- * Gets the sequence of this for each statement.`
	`11`	`+ * Gets the sequence which this statement is iterating over.`
`12`	`12`	`*/`
`13`	`13`
`14`		`- final Expr getSequence() {`
`15`		`- result = this.getIteratorVar().getInit(0)`
`16`		`- }`
	`14`	`+ final Expr getSequence() { result = this.getIteratorVar().getInit(0) }`
`17`	`15`	`}`