Skip to content

Commit 56256f1

Browse files
author
Owen Jones
committed
Minor typos in irept documentation
1 parent 3cf4e3a commit 56256f1

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/util/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ CPROVER codebase.
1212

1313
\subsection irept Irept Data Structure
1414

15-
There are a large number of kind of tree structured or tree-like data in
15+
There are a large number of kinds of tree structured or tree-like data in
1616
CPROVER. `irept` provides a single, unified representation for all of
1717
these, allowing structure sharing and reference counting of data. As
1818
such `irept` is the basic unit of data in CPROVER. Each `irept`
19-
contains[^2] a basic unit of data (of type `dt`) which contains four
19+
contains[^1] a basic unit of data (of type `dt`) which contains four
2020
things:
2121

22-
* `data`: A string[^3], which is returned when the `id()` function is
22+
* `data`: A string[^2], which is returned when the `id()` function is
2323
used.
2424

25-
* `named_sub`: A map from `irep_namet` (a string) to an `irept`. This
25+
* `named_sub`: A map from `irep_namet` (a string) to `irept`. This
2626
is used for named children, i.e. subexpressions, parameters, etc.
2727

2828
* `comments`: Another map from `irep_namet` to `irept` which is used
@@ -32,7 +32,7 @@ things:
3232
unnamed children.
3333

3434
The `irept::pretty` function outputs the contents of an `irept` directly
35-
and can be used to understand an debug problems with `irept`s.
35+
and can be used to understand and debug problems with `irept`s.
3636

3737
On their own `irept`s do not “mean” anything; they are effectively
3838
generic tree nodes. Their interpretation depends on the contents of
@@ -67,19 +67,19 @@ class’ named `typecast_exprt`. One key descendent of `exprt` is
6767
These are used to represent variables; the name of which can be found
6868
using the `get_identifier` accessor function.
6969

70-
`codet` inherits from `exprt` and is defined in `std_code.h`. They
71-
represent executable code; statements in C rather than expressions. In
70+
`codet` inherits from `exprt` and is defined in `std_code.h`. It
71+
represents executable code; statements in C rather than expressions. In
7272
the front-end there are versions of these that hold whole code blocks,
7373
but in goto-programs these have been flattened so that each `irept`
7474
represents one sequence point (almost one line of code / one
7575
semi-colon). The most common descendents of `codet` are `code_assignt`
7676
so a common pattern is to cast the `codet` to an assignment and then
7777
recurse on the expression on either side.
7878

79-
[^2]: Or references, if reference counted data sharing is enabled. It is
79+
[^1]: Or references, if reference counted data sharing is enabled. It is
8080
enabled by default; see the `SHARING` macro.
8181

82-
[^3]: Unless `USE_STD_STRING` is set, this is actually
82+
[^2]: Unless `USE_STD_STRING` is set, this is actually
8383
a `dstring` and thus an integer which is a reference into a string table
8484

8585
\dot

0 commit comments

Comments
 (0)