Skip to content

Commit f384611

Browse files
committed
"modelling" -> "modeling" in docs
1 parent 052b41a commit f384611

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/codeql/codeql-language-guides/customizing-library-models-for-cpp.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Since we are adding a new source, we need to add a tuple to the ``sourceModel``
9292
The first five values identify the callable (in this case a free function) to be modeled as a source.
9393

9494
- The first value ``"boost::asio"`` is the namespace name.
95-
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modelling a free function, the type is left blank.
95+
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
9696
- The third value ``False`` is a flag that indicates whether or not the sink also applies to all overrides of the method. For a free function, this should be ``False``.
9797
- The fourth value ``"read_until"`` is the function name.
9898
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name. In this case, we want the model to include all functions in ``boost::asio`` called ``read_until``.
@@ -128,7 +128,7 @@ Since we want to add a new sink, we need to add a tuple to the ``sinkModel`` ext
128128
The first five values identify the callable (in this case a free function) to be modeled as a sink.
129129

130130
- The first value ``"boost::asio"`` is the namespace name.
131-
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modelling a free function, the type is left blank.
131+
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
132132
- The third value ``False`` is a flag that indicates whether or not the sink also applies to all overrides of the method. For a free function, this should be ``False``.
133133
- The fourth value ``"write"`` is the function name.
134134
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name. In this case, we want the model to include all functions in ``boost::asio`` called ``write``.
@@ -165,7 +165,7 @@ Since we are adding flow through a function, we need to add tuples to the ``summ
165165
The first five values identify the callable (in this case free function) to be modeled as a summary.
166166

167167
- The first value ``"boost::asio"`` is the namespace name.
168-
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modelling a free function, the type is left blank.
168+
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
169169
- The third value ``False`` is a flag that indicates whether or not the sink also applies to all overrides of the method. For a free function, this should be ``False``.
170170
- The fourth value ``"buffer"`` is the function name.
171171
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name. In this case, we want the model to include all functions in ``boost::asio`` called ``buffer``.
@@ -207,7 +207,7 @@ Since we are adding a barrier, we need to add a tuple to the ``barrierModel`` ex
207207
The first five values identify the callable (in this case a free function) to be modeled as a barrier.
208208

209209
- The first value ``""`` is the namespace name.
210-
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modelling a free function, the type is left blank.
210+
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
211211
- The third value ``False`` is a flag that indicates whether or not the barrier also applies to all overrides of the method. For a free function, this should be ``False``.
212212
- The fourth value ``"mysql_real_escape_string"`` is the function name.
213213
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name.
@@ -247,7 +247,7 @@ Since we are adding a barrier guard, we need to add a tuple to the ``barrierGuar
247247
The first five values identify the callable (in this case a free function) to be modeled as a barrier guard.
248248

249249
- The first value ``""`` is the namespace name.
250-
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modelling a free function, the type is left blank.
250+
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
251251
- The third value ``False`` is a flag that indicates whether or not the barrier guard also applies to all overrides of the method. For a free function, this should be ``False``.
252252
- The fourth value ``"is_safe"`` is the function name.
253253
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name.

docs/ql-libraries/dataflow/dataflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ Content ContentSet::getAReadContent();
279279
which means that a `storeStep(n1, cs, n2)` will be interpreted as storing into _any_
280280
of `cs.getAStoreContent()`, and dually that a `readStep(n1, cs, n2)` will be
281281
interpreted as reading from _any_ of `cs.getAReadContent()`. In most cases, there
282-
will be a simple bijection between `ContentSet` and `Content`, but when modelling
282+
will be a simple bijection between `ContentSet` and `Content`, but when modeling
283283
for example flow through arrays it can be more involved (see [Example 4](#example-4)).
284284

285285
It generally makes sense for stores to target `PostUpdateNode`s, but this is not a strict

ruby/ql/docs/flow_summaries.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ If `preservesValue = true` then value flow is propagated. If it is `false` then
3939
only taint flow is propagated.
4040

4141
Any call to `chomp` in the database will be translated, in the dataflow graph,
42-
to a call to this fake definition.
42+
to a call to this fake definition.
4343

4444
`input` and `output` define the "from" and "to" locations in the flow summary.
4545
They use a custom string-based syntax which is similar to that used in `path`
@@ -232,7 +232,7 @@ preceding access path. It takes the same specifiers as `WithElement` and
232232
`Element`. It is only valid in an input path.
233233

234234
This component has the effect of excluding the relevant elements when copying
235-
from input to output. It is useful for modelling methods that remove elements
235+
from input to output. It is useful for modeling methods that remove elements
236236
from a collection. For example to model a method that removes the first element
237237
from the receiver, we can do so like this:
238238

0 commit comments

Comments
 (0)