Improve QLDoc for Config::FlowState in StringBreak

owen-mc · owen-mc · commit 089ea010d733 · 2023-08-10T15:50:01.000+01:00
diff --git a/go/ql/lib/semmle/go/security/StringBreak.qll b/go/ql/lib/semmle/go/security/StringBreak.qll
@@ -35,7 +35,7 @@ module StringBreak {
   }
 
   private module Config implements DataFlow::StateConfigSig {
-    /** The type of quote being tracked by this configuration. */
+    /** The flow state that we track is the type of quote used. */
     class FlowState = Quote;
 
     predicate isSource(DataFlow::Node source, FlowState state) {

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ module StringBreak {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`private module Config implements DataFlow::StateConfigSig {`
`38`		`- /** The type of quote being tracked by this configuration. */`
	`38`	`+ /** The flow state that we track is the type of quote used. */`
`39`	`39`	`class FlowState = Quote;`
`40`	`40`
`41`	`41`	`predicate isSource(DataFlow::Node source, FlowState state) {`