Skip to content

Commit 23213af

Browse files
committed
Try to make Acrolinx happier
1 parent 515d5b6 commit 23213af

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/code-quality/c6001.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,9 @@ int f( bool b )
4949

5050
## Heuristics
5151

52-
Variables are also considered initialized when they are passed by reference to
53-
another function. Thus, the example below would also consider `i` to be initialized.
52+
Variables are also considered initialized when they're passed by reference to
53+
another function. Thus, the following example would also consider `i` to be
54+
initialized.
5455

5556
```cpp
5657
void init( int& i );
@@ -69,15 +70,14 @@ int f( bool b )
6970
}
7071
```
7172
72-
This is to support the pattern of passing a pointer to a variable into an
73-
initialization function.
73+
This is to support the pattern of passing a pointer to a variable into
74+
an initialization function.
7475
75-
Note that many functions expect pointers to point to initialized data already,
76-
in which case this heuristic would lead to false negatives. [SAL annotations]
77-
such as `_In_` and `_Out_` can be used to more precisely describe a function's
78-
behavior. For example, in the following we call an external function that
79-
expects its argument to already be initialized and the warning is still
80-
generated.
76+
Since many functions expect pointers to point to initialized data already, this
77+
heuristic can lead to false negatives. [SAL annotations] such as `_In_` and
78+
`_Out_` can be used to more precisely describe a function's behavior. For
79+
example, in the following we call an external function that expects its argument
80+
to already be initialized and the warning is still generated.
8181
8282
```cpp
8383
void use( _In_ int& i );

0 commit comments

Comments
 (0)