Skip to content

Commit 9cd371f

Browse files
committed
Update some QLDoc comments
1 parent 275b2a9 commit 9cd371f

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

python/ql/lib/semmle/python/dataflow/new/internal/TypeTracker.qll

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ module StepSummary {
185185
}
186186

187187
/**
188-
* Holds if `nodeFrom` is being written to the `content` content of the object in `nodeTo`.
188+
* Holds if `nodeFrom` is being written to the `contents` of the object in `nodeTo`.
189189
*
190190
* Note that `nodeTo` will always be a local source node that flows to the place where the content
191191
* is written in `basicStoreStep`. This may lead to the flow of information going "back in time"
@@ -204,7 +204,7 @@ module StepSummary {
204204
* def bar(x):
205205
* z = x.attr
206206
* ```
207-
* for the attribute write `x.attr = y`, we will have `content` being the literal string `"attr"`,
207+
* for the attribute write `x.attr = y`, we will have `contents` being the literal string `"attr"`,
208208
* `nodeFrom` will be `y`, and `nodeTo` will be the object `Foo()` created on the first line of the
209209
* function. This means we will track the fact that `x.attr` can have the type of `y` into the
210210
* assignment to `z` inside `bar`, even though this attribute write happens _after_ `bar` is called.

ruby/ql/lib/codeql/ruby/typetracking/TypeTracker.qll

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ module StepSummary {
185185
}
186186

187187
/**
188-
* Holds if `nodeFrom` is being written to the `content` content of the object in `nodeTo`.
188+
* Holds if `nodeFrom` is being written to the `contents` of the object in `nodeTo`.
189189
*
190190
* Note that `nodeTo` will always be a local source node that flows to the place where the content
191191
* is written in `basicStoreStep`. This may lead to the flow of information going "back in time"
@@ -204,7 +204,7 @@ module StepSummary {
204204
* def bar(x):
205205
* z = x.attr
206206
* ```
207-
* for the attribute write `x.attr = y`, we will have `content` being the literal string `"attr"`,
207+
* for the attribute write `x.attr = y`, we will have `contents` being the literal string `"attr"`,
208208
* `nodeFrom` will be `y`, and `nodeTo` will be the object `Foo()` created on the first line of the
209209
* function. This means we will track the fact that `x.attr` can have the type of `y` into the
210210
* assignment to `z` inside `bar`, even though this attribute write happens _after_ `bar` is called.

ruby/ql/lib/codeql/ruby/typetracking/TypeTrackerSpecific.qll

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,11 @@ predicate returnStep(Node nodeFrom, Node nodeTo) {
117117
}
118118

119119
/**
120-
* Holds if `nodeFrom` is being written to the `content` content of the object
120+
* Holds if `nodeFrom` is being written to the `contents` of the object
121121
* in `nodeTo`.
122122
*
123123
* Note that the choice of `nodeTo` does not have to make sense
124-
* "chronologically". All we care about is whether the `content` content of
124+
* "chronologically". All we care about is whether the `contents` of
125125
* `nodeTo` can have a specific type, and the assumption is that if a specific
126126
* type appears here, then any access of that particular content can yield
127127
* something of that particular type.
@@ -140,7 +140,7 @@ predicate returnStep(Node nodeFrom, Node nodeTo) {
140140
* z = x.content
141141
* end
142142
* ```
143-
* for the content write `x.content = y`, we will have `content` being the
143+
* for the content write `x.content = y`, we will have `contents` being the
144144
* literal string `"content"`, `nodeFrom` will be `y`, and `nodeTo` will be the
145145
* `Foo` object created on the first line of the function. This means we will
146146
* track the fact that `x.content` can have the type of `y` into the assignment

0 commit comments

Comments
 (0)