Skip to content

Commit 9ad66df

Browse files
committed
Updated docs
Slightly updated wording in `Nodes` and added the correct link in `Edges`.
1 parent 155636e commit 9ad66df

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

docs/Edges.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Edges
22

3-
This project builds a graph based on a precice-config.xml file. The nodes in the graph correspond to the specified xml
4-
elements and tags.<br>
3+
This project builds a graph based on a `precice-config.xml` file.
4+
The nodes in the graph correspond to the specified xml elements and tags.<br>
55
The documentation for preCICE's config tags can be read
66
at [preCICE XML reference](https://precice.org/configuration-xml-reference.html).<br>
77
The edges mainly add redundancies to allow future checks to be less complex.
88

99
> [!NOTE]
10-
> This graph is built for the [preCICE logic checker](https://github.com/precice-forschungsprojekt/config-checker). This
11-
> means that there may redundancies or “inconsistencies” in the building of the graph itself.
10+
> This graph is built for the [preCICE config check](https://github.com/precice/config-check).
11+
> This means that there may redundancies or “inconsistencies” in the building of the graph itself,
12+
> to allow for easier traversing and checking later on.
1213
1314
Edges are modeled as an enum. The “type” of the edge is important for the checker;
1415
for the graph the type defines a label for the edge.

docs/Nodes.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,17 @@ the [preCICE XML reference](https://precice.org/configuration-XML-reference.html
88
> [!NOTE]
99
> This graph is built for both [preCICE config check](https://github.com/precice/config-check/)
1010
> and [preCICE case-generate](https://github.com/precice/case-generate).
11-
> This means that there may be redundancies or “inconsistencies” in the building of the graph itself.
11+
> This means that there may be redundancies or “inconsistencies” in the building of the graph itself,
12+
> to allow for easier traversing and checking later on.
1213
1314
Here you will find a list with brief explanations of each node and its parameters.
1415

1516
> [!NOTE]
16-
> Please note that since version 1.1, each node additionally has a method `to_xml()`,
17+
> Please note that since version 1.1.0, each node additionally has a method `to_xml()`,
1718
> to convert it back to a `precice-config.xml` element (string). <br>
1819
> To allow this conversion to be as thorough as possible, additional, _optional_ attributes were added to many nodes,
19-
> which are not listed here and _not_ required for using the graph. Their meaning can be inferred from their name or
20-
> the [preCICE XML reference](https://precice.org/configuration-xml-reference.html).
20+
> which are not listed here and are _not_ required for using the graph. Their meaning can be inferred from their name
21+
> or the [preCICE XML reference](https://precice.org/configuration-xml-reference.html).
2122
2223
## Participant
2324

0 commit comments

Comments
 (0)