fill in docstring

erik-krogh · erik-krogh · commit 34778578dbfd · 2020-08-10T13:34:36.000+02:00
diff --git a/javascript/ql/src/semmle/javascript/dataflow/internal/FlowSteps.qll b/javascript/ql/src/semmle/javascript/dataflow/internal/FlowSteps.qll
@@ -67,7 +67,7 @@ predicate localExceptionStep(DataFlow::Node pred, DataFlow::Node succ) {
 /**
  * Holds if an exception thrown from `pred` can propagate locally to `succ`.
  *
- * The `async` flag is true if the successor
+ * The `async` flag is true if the step involves wrapping the exception in a rejected Promise.
  */
 predicate localExceptionStepWithAsyncFlag(DataFlow::Node pred, DataFlow::Node succ, boolean async) {
   exists(DataFlow::Node target | target = getThrowTarget(pred) |

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ predicate localExceptionStep(DataFlow::Node pred, DataFlow::Node succ) {`
`67`	`67`	`/**`
`68`	`68`	* Holds if an exception thrown from `pred` can propagate locally to `succ`.
`69`	`69`	`*`
`70`		- * The `async` flag is true if the successor
	`70`	+ * The `async` flag is true if the step involves wrapping the exception in a rejected Promise.
`71`	`71`	`*/`
`72`	`72`	`predicate localExceptionStepWithAsyncFlag(DataFlow::Node pred, DataFlow::Node succ, boolean async) {`
`73`	`73`	`exists(DataFlow::Node target \| target = getThrowTarget(pred) \|`