Python: Improve QLDoc for ExternalStringDictKind

RasmusWL · RasmusWL · commit 48be57c8fd05 · 2020-05-29T12:06:57.000+02:00
diff --git a/python/ql/src/semmle/python/security/strings/External.qll b/python/ql/src/semmle/python/security/strings/External.qll
@@ -60,14 +60,14 @@ class ExternalJsonKind extends TaintKind {
     }
 }
 
-/** A kind of "taint", representing a dictionary mapping str->"taint" */
+/** A kind of "taint", representing a dictionary mapping keys to tainted strings. */
 class ExternalStringDictKind extends DictKind {
     ExternalStringDictKind() { this.getValue() instanceof ExternalStringKind }
 }
 
 /**
- * A kind of "taint", representing a dictionary mapping strings to sequences of
- *  tainted strings
+ * A kind of "taint", representing a dictionary mapping keys to sequences of
+ *  tainted strings.
  */
 class ExternalStringSequenceDictKind extends DictKind {
     ExternalStringSequenceDictKind() { this.getValue() instanceof ExternalStringSequenceKind }

Original file line number	Diff line number	Diff line change
`@@ -60,14 +60,14 @@ class ExternalJsonKind extends TaintKind {`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`
`63`		`-/** A kind of "taint", representing a dictionary mapping str->"taint" */`
	`63`	`+/** A kind of "taint", representing a dictionary mapping keys to tainted strings. */`
`64`	`64`	`class ExternalStringDictKind extends DictKind {`
`65`	`65`	`ExternalStringDictKind() { this.getValue() instanceof ExternalStringKind }`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`/**`
`69`		`- * A kind of "taint", representing a dictionary mapping strings to sequences of`
`70`		`- * tainted strings`
	`69`	`+ * A kind of "taint", representing a dictionary mapping keys to sequences of`
	`70`	`+ * tainted strings.`
`71`	`71`	`*/`
`72`	`72`	`class ExternalStringSequenceDictKind extends DictKind {`
`73`	`73`	`ExternalStringSequenceDictKind() { this.getValue() instanceof ExternalStringSequenceKind }`