improve feature documentation

esbena · Stephan Brandauer · commit c4c4d288cb7b · 2022-09-01T16:05:31.000+02:00
diff --git a/javascript/ql/experimental/adaptivethreatmodeling/lib/experimental/adaptivethreatmodeling/EndpointFeatures.qll b/javascript/ql/experimental/adaptivethreatmodeling/lib/experimental/adaptivethreatmodeling/EndpointFeatures.qll
@@ -453,6 +453,8 @@ private module SyntacticUtilities {
    *
    * Supports:
    * - variable reads (including `this` and `super`)
+   * - imports
+   * - await
    * - property reads
    * - invocations
    *
@@ -488,6 +490,13 @@ private module SyntacticUtilities {
     )
   }
 
+  /**
+   * Gets the imported path.
+   *
+   * XXX To avoid teaching the ML model about npm packages, only relative paths are supported
+   *
+   * Unknown paths result in `?`.
+   */
   string getSimpleImportPath(Import i) {
     if exists(i.getImportedPath().getValue())
     then

Original file line number	Diff line number	Diff line change
`@@ -453,6 +453,8 @@ private module SyntacticUtilities {`
`453`	`453`	`*`
`454`	`454`	`* Supports:`
`455`	`455`	* - variable reads (including `this` and `super`)
	`456`	`+ * - imports`
	`457`	`+ * - await`
`456`	`458`	`* - property reads`
`457`	`459`	`* - invocations`
`458`	`460`	`*`
`@@ -488,6 +490,13 @@ private module SyntacticUtilities {`
`488`	`490`	`)`
`489`	`491`	`}`
`490`	`492`
	`493`	`+ /**`
	`494`	`+ * Gets the imported path.`
	`495`	`+ *`
	`496`	`+ * XXX To avoid teaching the ML model about npm packages, only relative paths are supported`
	`497`	`+ *`
	`498`	+ * Unknown paths result in `?`.
	`499`	`+ */`
`491`	`500`	`string getSimpleImportPath(Import i) {`
`492`	`501`	`if exists(i.getImportedPath().getValue())`
`493`	`502`	`then`