Skip to content

Commit e7bfc07

Browse files
committed
doc: review graph.md
1 parent fe93140 commit e7bfc07

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

‎docs/md/graph.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ if(adjacency_matrix.contains(0u, 1u)) {
5454
}
5555
```
5656

57-
Both `insert` and` erase` are _idempotent_ functions which have no effect if the
57+
Both `insert` and `erase` are _idempotent_ functions that have no effect if the
5858
element already exists or has already been deleted.<br/>
5959
The first one returns an `std::pair` containing the iterator to the element and
6060
a boolean value indicating whether the element was newly inserted or not. The
@@ -86,9 +86,8 @@ for(auto last = adjacency_matrix.size(), pos = {}; pos < last; ++pos) {
8686
```
8787

8888
As for visiting the edges, a few functions are available.<br/>
89-
When the purpose is to visit all the edges of a given adjacency matrix, the
90-
`edges` function returns an iterable object that is used to get them as pairs of
91-
vertices:
89+
To visit all the edges in an adjacency matrix, use the `edges` function. It
90+
returns an iterable object that yields the edges as pairs of vertices:
9291

9392
```cpp
9493
for(auto [lhs, rhs]: adjacency_matrix.edges()) {
@@ -146,8 +145,8 @@ of the library.
146145
This class is designed as a sort of _state machine_ to which a specific task is
147146
attached for which the resources accessed in read-only or read-write mode are
148147
specified.<br/>
149-
Most of the functions in the API also return the flow builder itself, according
150-
to what is the common sense API when it comes to builder classes.
148+
Most functions in the API also return the flow builder itself, as is common in
149+
builder APIs.
151150

152151
Once all tasks are registered and resources assigned to them, an execution graph
153152
in the form of an adjacency matrix is returned to the user.<br/>
@@ -180,8 +179,8 @@ Indeed, the use of `id_type` as an identifier type is not by accident. In fact,
180179
it matches well with the internal hashed string class. Moreover, it is also the
181180
same type returned by the hash function of the internal RTTI system, in case the
182181
user wants to rely on that.<br/>
183-
However, being an integral value, it leaves the user full freedom to rely on his
184-
own tools if necessary.
182+
However, because it is an integral value, users remain free to rely on their own
183+
tools if necessary.
185184

186185
Once a task is associated with the flow builder, it has also assigned read-only
187186
or read-write resources as appropriate:

0 commit comments

Comments
 (0)