Skip to content

Commit 5a7b1b9

Browse files
committed
Fix mistakes in explanation of override column
To avoid copy-paste mistakes and make them more consistent we just use the word "model".
1 parent 2c16cb4 commit 5a7b1b9

File tree

4 files changed

+27
-27
lines changed

4 files changed

+27
-27
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
@@ -93,7 +93,7 @@ The first five values identify the callable (in this case a free function) to be
9393

9494
- The first value ``"boost::asio"`` is the namespace name.
9595
- 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.
96-
- 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``.
96+
- The third value ``False`` is a flag that indicates whether or not the model 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``.
9999

@@ -129,7 +129,7 @@ The first five values identify the callable (in this case a free function) to be
129129

130130
- The first value ``"boost::asio"`` is the namespace name.
131131
- 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.
132-
- 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``.
132+
- The third value ``False`` is a flag that indicates whether or not the model 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``.
135135

@@ -166,7 +166,7 @@ The first five values identify the callable (in this case free function) to be m
166166

167167
- The first value ``"boost::asio"`` is the namespace name.
168168
- 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.
169-
- 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``.
169+
- The third value ``False`` is a flag that indicates whether or not the model 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``.
172172

@@ -208,7 +208,7 @@ The first five values identify the callable (in this case a free function) to be
208208

209209
- The first value ``""`` is the namespace name.
210210
- 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.
211-
- 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``.
211+
- The third value ``False`` is a flag that indicates whether or not the model 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.
214214

@@ -248,7 +248,7 @@ The first five values identify the callable (in this case a free function) to be
248248

249249
- The first value ``""`` is the namespace name.
250250
- 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.
251-
- 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``.
251+
- The third value ``False`` is a flag that indicates whether or not the model 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.
254254

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The first five values identify the callable (in this case a method) to be modele
9898

9999
- The first value ``System.Data.SqlClient`` is the namespace name.
100100
- The second value ``SqlCommand`` is the name of the class (type) that contains the method.
101-
- The third value ``False`` is a flag that indicates whether or not the sink also applies to all overrides of the method.
101+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method.
102102
- The fourth value ``SqlCommand`` is the method name. Constructors are named after the class.
103103
- The fifth value ``(System.String,System.Data.SqlClient.SqlConnection)`` is the method input type signature. The type names must be fully qualified.
104104

@@ -138,7 +138,7 @@ The first five values identify the callable (in this case a method) to be modele
138138

139139
- The first value ``System.Net.Sockets`` is the namespace name.
140140
- The second value ``TcpClient`` is the name of the class (type) that contains the source.
141-
- The third value ``False`` is a flag that indicates whether or not the source also applies to all overrides of the method.
141+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method.
142142
- The fourth value ``GetStream`` is the method name.
143143
- The fifth value ``()`` is the method input type signature.
144144

@@ -182,7 +182,7 @@ These are the same for both of the rows above as we are adding two summaries for
182182

183183
- The first value ``System`` is the namespace name.
184184
- The second value ``String`` is the class (type) name.
185-
- The third value ``False`` is a flag that indicates whether or not the summary also applies to all overrides of the method.
185+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method.
186186
- The fourth value ``Concat`` is the method name.
187187
- The fifth value ``(System.Object,System.Object)`` is the method input type signature.
188188

@@ -238,7 +238,7 @@ These are the same for both of the rows above as we are adding two summaries for
238238

239239
- The first value ``System`` is the namespace name.
240240
- The second value ``String`` is the class (type) name.
241-
- The third value ``False`` is a flag that indicates whether or not the summary also applies to all overrides of the method.
241+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method.
242242
- The fourth value ``Trim`` is the method name.
243243
- The fifth value ``()`` is the method input type signature.
244244

@@ -282,7 +282,7 @@ These are the same for both of the rows above as we are adding two summaries for
282282

283283
- The first value ``System.Linq`` is the namespace name.
284284
- The second value ``Enumerable`` is the class (type) name.
285-
- The third value ``False`` is a flag that indicates whether or not the summary also applies to all overrides of the method.
285+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method.
286286
- The fourth value ``Select<TSource,TResult>`` is the method name, along with the type parameters for the method. The names of the generic type parameters provided in the model must match the names of the generic type parameters in the method signature in the source code.
287287
- The fifth value ``(System.Collections.Generic.IEnumerable<TSource>,System.Func<TSource,TResult>)`` is the method input type signature. The generics in the signature must match the generics in the method signature in the source code.
288288

@@ -339,7 +339,7 @@ The first five values identify the callable (in this case the getter of a proper
339339

340340
- The first value ``System.Web`` is the namespace name.
341341
- The second value ``HttpRequest`` is the class (type) name.
342-
- The third value ``False`` is a flag that indicates whether or not the barrier also applies to all overrides of the method.
342+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method.
343343
- The fourth value ``get_RawUrl`` is the method name. Getter and setter methods are named ``get_<name>`` and ``set_<name>`` respectively.
344344
- The fifth value ``()`` is the method input type signature.
345345

@@ -381,7 +381,7 @@ The first five values identify the callable (in this case the getter of a proper
381381

382382
- The first value ``System`` is the namespace name.
383383
- The second value ``Uri`` is the class (type) name.
384-
- The third value ``False`` is a flag that indicates whether or not the barrier guard also applies to all overrides of the method.
384+
- The third value ``False`` is a flag that indicates whether or not the model guard also applies to all overrides of the method.
385385
- The fourth value ``get_IsAbsoluteUri`` is the method name. Getter and setter methods are named ``get_<name>`` and ``set_<name>`` respectively.
386386
- The fifth value ``()`` is the method input type signature.
387387

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The first five values identify the function (in this case a method) to be modele
9898

9999
- The first value ``database/sql`` is the package name.
100100
- The second value ``DB`` is the name of the type that the method is associated with.
101-
- The third value ``True`` is a flag that indicates whether or not the sink also applies to subtypes. This includes when the subtype embeds the given type, so that the method or field is promoted to be a method or field of the subtype. For interface methods it also includes types which implement the interface type.
101+
- The third value ``True`` is a flag that indicates whether or not the model also applies to subtypes. This includes when the subtype embeds the given type, so that the method or field is promoted to be a method or field of the subtype. For interface methods it also includes types which implement the interface type.
102102
- The fourth value ``Prepare`` is the method name.
103103
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
104104

@@ -139,7 +139,7 @@ The first five values identify the function to be modeled as a source.
139139

140140
- The first value ``net/http`` is the package name.
141141
- The second value ``Request`` is the type name, since the function is a method of the ``Request`` type.
142-
- The third value ``True`` is a flag that indicates whether or not the sink also applies to subtypes. This includes when the subtype embeds the given type, so that the method or field is promoted to be a method or field of the subtype. For interface methods it also includes types which implement the interface type.
142+
- The third value ``True`` is a flag that indicates whether or not the model also applies to subtypes. This includes when the subtype embeds the given type, so that the method or field is promoted to be a method or field of the subtype. For interface methods it also includes types which implement the interface type.
143143
- The fourth value ``FormValue`` is the function name.
144144
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
145145

@@ -182,7 +182,7 @@ The first five values identify the function to be modeled as a summary.
182182

183183
- The first value ``slices`` is the package name.
184184
- The second value ``""`` is left blank, since the function is not a method of a type.
185-
- The third value ``False`` is a flag that indicates whether or not the sink also applies to subtypes. This has no effect for non-method functions.
185+
- The third value ``False`` is a flag that indicates whether or not the model also applies to subtypes. This has no effect for non-method functions.
186186
- The fourth value ``Max`` is the function name.
187187
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
188188

@@ -227,7 +227,7 @@ The first five values identify the function to be modeled as a summary.
227227

228228
- The first value ``slices`` is the package name.
229229
- The second value ``""`` is left blank, since the function is not a method of a type.
230-
- The third value ``False`` is a flag that indicates whether or not the sink also applies to subtypes. This has no effect for non-method functions.
230+
- The third value ``False`` is a flag that indicates whether or not the model also applies to subtypes. This has no effect for non-method functions.
231231
- The fourth value ``Max`` is the function name.
232232
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
233233

@@ -274,7 +274,7 @@ These are the same for both of the rows above as we are adding two summaries for
274274

275275
- The first value ``strings`` is the package name.
276276
- The second value ``""`` is left blank, since the function is not a method of a type.
277-
- The third value ``False`` is a flag that indicates whether or not the sink also applies to subtypes. This has no effect for non-method functions.
277+
- The third value ``False`` is a flag that indicates whether or not the model also applies to subtypes. This has no effect for non-method functions.
278278
- The fourth value ``Join`` is the function name.
279279
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
280280

@@ -329,7 +329,7 @@ The first five values identify the function (in this case a method) to be modele
329329

330330
- The first value ``net/url`` is the package name.
331331
- The second value ``URL`` is the receiver type.
332-
- The third value ``True`` is a flag that indicates whether or not the sink also applies to subtypes. This includes when the subtype embeds the given type, so that the method or field is promoted to be a method or field of the subtype. For interface methods it also includes types which implement the interface type.
332+
- The third value ``True`` is a flag that indicates whether or not the model also applies to subtypes. This includes when the subtype embeds the given type, so that the method or field is promoted to be a method or field of the subtype. For interface methods it also includes types which implement the interface type.
333333
- The fourth value ``Hostname`` is the method name.
334334
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
335335

@@ -370,7 +370,7 @@ The first five values identify the function to be modeled as a barrier.
370370

371371
- The first value ``group:beego`` is the package group name. The ``group:`` prefix indicates that this is a package group, which is used to match multiple package paths that refer to the same package.
372372
- The second value ``""`` is left blank since the function is not a method of a type.
373-
- The third value ``True`` is a flag that indicates whether or not the barrier also applies to subtypes. This has no effect for non-method functions.
373+
- The third value ``True`` is a flag that indicates whether or not the model also applies to subtypes. This has no effect for non-method functions.
374374
- The fourth value ``Htmlquote`` is the function name.
375375
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string.
376376

@@ -411,7 +411,7 @@ The first five values identify the function to be modeled as a barrier guard.
411411

412412
- The first value ``example.com/example`` is the package name.
413413
- The second value ``""`` is left blank since the function is not a method of a type.
414-
- The third value ``False`` is a flag that indicates whether or not the barrier guard also applies to subtypes. This has no effect for non-method functions.
414+
- The third value ``False`` is a flag that indicates whether or not the model guard also applies to subtypes. This has no effect for non-method functions.
415415
- The fourth value ``IsSafe`` is the function name.
416416
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string.
417417

@@ -450,7 +450,7 @@ The first five values identify the field to be modeled as a source.
450450

451451
- The first value ``net/http`` is the package name.
452452
- The second value ``Request`` is the name of the type that the field is associated with.
453-
- The third value ``True`` is a flag that indicates whether or not the sink also applies to subtypes. For fields this means when the field is accessed as a promoted field in another type.
453+
- The third value ``True`` is a flag that indicates whether or not the model also applies to subtypes. For fields this means when the field is accessed as a promoted field in another type.
454454
- The fourth value ``Body`` is the field name.
455455
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
456456

0 commit comments

Comments
 (0)