Skip to content

Commit 1f8f445

Browse files
committed
Improve documentation clarity
1 parent 96813f5 commit 1f8f445

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/cprover-manual/api.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,10 @@ the array **dest** with the given value.
132132
__CPROVER_bool __CPROVER_enum_is_in_range();
133133
```
134134

135-
The function **\_\_CPROVER\_enum\_is\_in\_range** returns true
136-
if their one argument (an `enum`) is one of the defined values for
137-
the enumeration. For example
135+
The function **\_\_CPROVER\_enum\_is\_in\_range** is used to check
136+
that an enumeration has one of the defined enumeration values. In
137+
the following example `__CPROVER_enum_is_in_range(ev1)` will return
138+
true and the assertion will pass
138139
```C
139140
enum my_enum { first, second };
140141

@@ -144,7 +145,7 @@ int main()
144145
assert(__CPROVER_enum_is_in_range(ev1));
145146
}
146147
```
147-
would return true, while the following example
148+
However, in the example below the assertion will fail
148149
```C
149150
enum my_enum { first, second };
150151
@@ -154,7 +155,7 @@ int main()
154155
assert(__CPROVER_enum_is_in_range(ev1));
155156
}
156157
```
157-
would return false.
158+
158159

159160
#### Uninterpreted Functions
160161

0 commit comments

Comments
 (0)