Improve docs after PR comment

Stephan Brandauer · asgerf · web-flow · commit ee280cda324d · 2022-04-27T16:24:20.000+02:00
Co-authored-by: Asger F &lt;asgerf@github.com&gt;
diff --git a/javascript/ql/lib/semmle/javascript/dataflow/internal/FlowSteps.qll b/javascript/ql/lib/semmle/javascript/dataflow/internal/FlowSteps.qll
@@ -270,7 +270,7 @@ private module CachedSteps {
    * Gets a data-flow node that refers to the `i`th parameter of `f` through its `...rest` argument.
    *
    * If there is normal arguments before `...rest`, we have to account for them.
-   * Eg., a function `function f(a, ...rest) { console.log(rest[1]); }`:
+   * For example, a function `function f(a, ...rest) { console.log(rest[1]); }`:
    * Here, `restParameterAccess(_, 2)` will return `rest[1]`, because there is the leading
    * `a` parameter.
    */

Original file line number	Diff line number	Diff line change
`@@ -270,7 +270,7 @@ private module CachedSteps {`
`270`	`270`	* Gets a data-flow node that refers to the `i`th parameter of `f` through its `...rest` argument.
`271`	`271`	`*`
`272`	`272`	* If there is normal arguments before `...rest`, we have to account for them.
`273`		- * Eg., a function `function f(a, ...rest) { console.log(rest[1]); }`:
	`273`	+ * For example, a function `function f(a, ...rest) { console.log(rest[1]); }`:
`274`	`274`	* Here, `restParameterAccess(_, 2)` will return `rest[1]`, because there is the leading
`275`	`275`	* `a` parameter.
`276`	`276`	`*/`