Ruby: clarify what getAnElement() does

asgerf · asgerf · commit e09a5e87dd4e · 2022-09-28T10:49:34.000+02:00
diff --git a/ruby/ql/lib/codeql/ruby/ApiGraphs.qll b/ruby/ql/lib/codeql/ruby/ApiGraphs.qll
@@ -276,7 +276,7 @@ module API {
     /** Gets a node representing the instance field of the given `name`, which must include the `@` character. */
     Node getField(string name) { result = this.getContent(DataFlowPrivate::TFieldContent(name)) }
 
-    /** Gets a node representing an element of this collection. */
+    /** Gets a node representing an element of this collection (known or unknown). */
     Node getAnElement() {
       result = this.getContents(any(DataFlow::ContentSet set | set.isAnyElement()))
     }

Original file line number	Diff line number	Diff line change
`@@ -276,7 +276,7 @@ module API {`
`276`	`276`	/** Gets a node representing the instance field of the given `name`, which must include the `@` character. */
`277`	`277`	`Node getField(string name) { result = this.getContent(DataFlowPrivate::TFieldContent(name)) }`
`278`	`278`
`279`		`- /** Gets a node representing an element of this collection. */`
	`279`	`+ /** Gets a node representing an element of this collection (known or unknown). */`
`280`	`280`	`Node getAnElement() {`
`281`	`281`	`result = this.getContents(any(DataFlow::ContentSet set \| set.isAnyElement()))`
`282`	`282`	`}`