Skip to content

Commit df398fb

Browse files
committed
Ruby: Add more flow summary tests
1 parent fe13ac1 commit df398fb

File tree

4 files changed

+2226
-7
lines changed

4 files changed

+2226
-7
lines changed

ruby/ql/docs/flow_summaries.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -181,9 +181,10 @@ Any element at a known index greater or equal to the integer.
181181

182182
#### `<string>`, `<string>!`
183183
An element at the index given by string. The string should match the result of
184-
`serialize()` on the `ConstantValue` that represents the index. This is
185-
typically something like `foo` for the string key `"foo"` and `:foo` for the
186-
symbol `:foo`.
184+
`serialize()` on the `ConstantValue` that represents the index. For a string
185+
with contents `foo` this is `"foo"` and for a symbol `:foo` it is `:foo`. The
186+
Ruby values `true`, `false` and `nil` can be written verbatim. See tests 31-33
187+
for examples.
187188

188189
## `Field`
189190
A "field" in the object. In practice this refers to a value stored in an
@@ -192,8 +193,7 @@ instance variable in the object. The only valid specifier is `@<string>`, where
192193
setter call such as `x.foo = bar` means there is a field `foo` in `x`, backed by
193194
an instance variable `@foo`.
194195

195-
For example, the access path `Argument[0].Field[@foo]` would refer to the value
196-
`"foo"` in
196+
For example, the access path `Argument[0].Field[@foo]` would refer to the value `"foo"` in
197197

198198
```rb
199199
x = SomeClass.new

0 commit comments

Comments
 (0)