expand qldoc for getNumArgument

erik-krogh · RasmusWL · web-flow · commit b6a4f4373730 · 2022-05-23T18:51:33.000+02:00
Co-authored-by: Rasmus Wriedt Larsen &lt;rasmuswriedtlarsen@gmail.com&gt;
diff --git a/python/ql/lib/semmle/python/ApiGraphs.qll b/python/ql/lib/semmle/python/ApiGraphs.qll
@@ -355,7 +355,12 @@ module API {
       result.getAnImmediateUse() = this
     }
 
-    /** Gets the number of arguments of this call. Both positional and named arguments are counted. */
+    /**
+     * Gets the number of positional arguments of this call.
+     *
+     * Note: This is used for `WithArity[<n>]` in modeling-as-data, where we thought 
+     * including keyword arguments didn't make much sense.
+     */
     int getNumArgument() { result = count(this.getArg(_)) }
   }
 

Original file line number	Diff line number	Diff line change
`@@ -355,7 +355,12 @@ module API {`
`355`	`355`	`result.getAnImmediateUse() = this`
`356`	`356`	`}`
`357`	`357`
`358`		`- /** Gets the number of arguments of this call. Both positional and named arguments are counted. */`
	`358`	`+ /**`
	`359`	`+ * Gets the number of positional arguments of this call.`
	`360`	`+ *`
	`361`	+ * Note: This is used for `WithArity[<n>]` in modeling-as-data, where we thought
	`362`	`+ * including keyword arguments didn't make much sense.`
	`363`	`+ */`
`359`	`364`	`int getNumArgument() { result = count(this.getArg(_)) }`
`360`	`365`	`}`
`361`	`366`