Python: Improve qldoc for ClassValue::getABaseType

RasmusWL · RasmusWL · commit c50d366527f3 · 2019-10-24T17:10:42.000+02:00
Hopefully it is more clear that you can get multiple results from getABaseType
because of multiple inheritance, and not because we are following the chain of
inheritance
diff --git a/python/ql/src/semmle/python/objects/ObjectAPI.qll b/python/ql/src/semmle/python/objects/ObjectAPI.qll
@@ -384,12 +384,12 @@ class ClassValue extends Value {
         Types::failedInference(this, reason)
     }
 
-    /** Gets the nth base class of this class */
+    /** Gets the nth immediate base type of this class. */
     ClassValue getBaseType(int n) {
         result = Types::getBase(this, n)
     }
 
-    /** Gets a base class of this class */
+    /** Gets an immediate base type of this class. */
     ClassValue getABaseType() {
         result = Types::getBase(this, _)
     }

Original file line number	Diff line number	Diff line change
`@@ -384,12 +384,12 @@ class ClassValue extends Value {`
`384`	`384`	`Types::failedInference(this, reason)`
`385`	`385`	`}`
`386`	`386`
`387`		`- /** Gets the nth base class of this class */`
	`387`	`+ /** Gets the nth immediate base type of this class. */`
`388`	`388`	`ClassValue getBaseType(int n) {`
`389`	`389`	`result = Types::getBase(this, n)`
`390`	`390`	`}`
`391`	`391`
`392`		`- /** Gets a base class of this class */`
	`392`	`+ /** Gets an immediate base type of this class. */`
`393`	`393`	`ClassValue getABaseType() {`
`394`	`394`	`result = Types::getBase(this, _)`
`395`	`395`	`}`