Polish FlaskMail qldocs

2026-04-28 10:15:14 +02:00 · 2021-11-13 02:12:22 +01:00
parent 1393b5b157
commit 33b6f6fe61
1 changed files with 6 additions and 0 deletions
--- a/python/ql/src/experimental/semmle/python/libraries/FlaskMail.qll
+++ b/python/ql/src/experimental/semmle/python/libraries/FlaskMail.qll
@@ -26,6 +26,12 @@ private module FlaskMail {

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