Skip to content

Commit 33b6f6f

Browse files
committed
Polish FlaskMail qldocs
1 parent 1393b5b commit 33b6f6f

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

python/ql/src/experimental/semmle/python/libraries/FlaskMail.qll

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ private module FlaskMail {
2626

2727
/**
2828
* Gets a reference to an argument from `flask_mail.Message`, `flask_sendmail.Message` and `flask.ext.sendmail.Message`.
29+
*
30+
* Usage example:
31+
*
32+
* ```codeql
33+
* DataFlow::Node getPlainTextBody() { result = getFlaskMailArgument(2, "body") }
34+
* ```
2935
*/
3036
bindingset[argumentPosition, argumentName]
3137
private DataFlow::Node getFlaskMailArgument(int argumentPosition, string argumentName) {

0 commit comments

Comments
 (0)