Merge pull request #6738 from RasmusWL/qldoc-getArgByName

yoff · web-flow · commit c1c63d0c28e8 · 2021-09-30T14:11:18.000+02:00
Python: Add QLDoc to `Function.getArgByName`
diff --git a/python/ql/lib/semmle/python/Function.qll b/python/ql/lib/semmle/python/Function.qll
@@ -58,6 +58,7 @@ class Function extends Function_, Scope, AstNode {
   /** Gets the name of the nth argument (for simple arguments) */
   string getArgName(int index) { result = this.getArg(index).(Name).getId() }
 
+  /** Gets the parameter of this function with the name `name`. */
   Parameter getArgByName(string name) {
     (
       result = this.getAnArg()

Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ class Function extends Function_, Scope, AstNode {`
`58`	`58`	`/** Gets the name of the nth argument (for simple arguments) */`
`59`	`59`	`string getArgName(int index) { result = this.getArg(index).(Name).getId() }`
`60`	`60`
	`61`	+ /** Gets the parameter of this function with the name `name`. */
`61`	`62`	`Parameter getArgByName(string name) {`
`62`	`63`	`(`
`63`	`64`	`result = this.getAnArg()`