Skip to content

Commit 76f0809

Browse files
committed
Python: Add missing QLDoc
1 parent cfa72af commit 76f0809

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

python/ql/src/semmle/python/Concepts.qll

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,13 @@ class ErrorInfoSource extends DataFlow::Node {
308308

309309
/** Provides a class for modeling new sources of error information, say via APIs. */
310310
module ErrorInfoSource {
311+
/**
312+
* A data-flow node that carries information about an error. Such information should
313+
* rarely be exposed directly to the user.
314+
*
315+
* Extend this class to model new APIs. If you want to refine existing API models,
316+
* extend `ErrorInfoSource` instead.
317+
*/
311318
abstract class Range extends DataFlow::Node { }
312319
}
313320

@@ -325,6 +332,12 @@ class ExceptionSource extends ErrorInfoSource::Range {
325332

326333
/** Provides a class for modeling new sources of exceptions, say via APIs. */
327334
module ExceptionSource {
335+
/**
336+
* A data-flow node that represents the creation or introduction of an exception.
337+
*
338+
* Extend this class to model new APIs. If you want to refine existing API models,
339+
* extend `ExceptionSource` instead.
340+
*/
328341
abstract class Range extends DataFlow::Node { }
329342
}
330343

0 commit comments

Comments
 (0)