Merge pull request #2194 from RasmusWL/python-improve-getbasetype-qldoc

tausbn · web-flow · commit 04e368303506 · 2019-10-28T17:07:19.000+01:00
Python: Improve qldoc for ClassValue::getABaseType
diff --git a/python/ql/src/semmle/python/objects/ObjectAPI.qll b/python/ql/src/semmle/python/objects/ObjectAPI.qll
@@ -389,12 +389,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
`@@ -389,12 +389,12 @@ class ClassValue extends Value {`
`389`	`389`	`Types::failedInference(this, reason)`
`390`	`390`	`}`
`391`	`391`
`392`		`- /** Gets the nth base class of this class */`
	`392`	`+ /** Gets the nth immediate base type of this class. */`
`393`	`393`	`ClassValue getBaseType(int n) {`
`394`	`394`	`result = Types::getBase(this, n)`
`395`	`395`	`}`
`396`	`396`
`397`		`- /** Gets a base class of this class */`
	`397`	`+ /** Gets an immediate base type of this class. */`
`398`	`398`	`ClassValue getABaseType() {`
`399`	`399`	`result = Types::getBase(this, _)`
`400`	`400`	`}`