Ruby: More QLDoc police

asgerf · asgerf · commit e47deaffbf6c · 2022-09-28T10:49:34.000+02:00
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/TypeTrackerSpecific.qll b/python/ql/lib/semmle/python/dataflow/new/internal/TypeTrackerSpecific.qll
@@ -25,7 +25,7 @@ class TypeTrackerContent extends OptionalTypeTrackerContent {
   TypeTrackerContent() { this != "" }
 }
 
-/** The content string representing no value. */
+/** Gets the content string representing no value. */
 OptionalTypeTrackerContent noContent() { result = "" }
 
 /** A content set, which is currently just a singleton set for Python. */
diff --git a/ruby/ql/lib/codeql/ruby/typetracking/TypeTrackerSpecific.qll b/ruby/ql/lib/codeql/ruby/typetracking/TypeTrackerSpecific.qll
@@ -167,8 +167,8 @@ predicate basicStoreStep(Node nodeFrom, Node nodeTo, TypeTrackerContentSet conte
 }
 
 /**
- * A `content`-store step from `nodeFrom -> nodeTo` where the destination node is a post-update
- * node that should be treated as a local source node.
+ * Holds if a store step `nodeFrom -> nodeTo` with `contents` exists, where the destination node
+ * is a post-update node that should be treated as a local source node.
  */
 predicate postUpdateStoreStep(Node nodeFrom, Node nodeTo, TypeTrackerContentSet contents) {
   // TODO: support SetterMethodCall inside TuplePattern

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class TypeTrackerContent extends OptionalTypeTrackerContent {`
`25`	`25`	`TypeTrackerContent() { this != "" }`
`26`	`26`	`}`
`27`	`27`
`28`		`-/** The content string representing no value. */`
	`28`	`+/** Gets the content string representing no value. */`
`29`	`29`	`OptionalTypeTrackerContent noContent() { result = "" }`
`30`	`30`
`31`	`31`	`/** A content set, which is currently just a singleton set for Python. */`