Skip to content

Commit be27114

Browse files
gicmojgrewe
authored andcommitted
[docs] versioning.md: fix wording and typos
1 parent 9837cad commit be27114

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/versioning.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ each other.
1414

1515
## file format versioning scheme
1616

17-
The file format is versioned with a triplet of integers, that carry
18-
semantics and can and must be used libraries that are about to open
19-
NIX files to determine if it indeed can read or write the file.
17+
The file format is versioned with a triplet of integers, that carries
18+
semantics, thus can and indeed *must* be used libraries that want to
19+
open NIX files to determine if the version of the file is compatible
20+
with the library version (i.e. the file can be read or written to).
2021

2122
The meaning of the individual numbers are as follows:
2223

@@ -34,9 +35,9 @@ the two critical scenarios that might occur:
3435
2. An old library (OL) wants to open a file that is newer (NF)
3536

3637

37-
If all components but the last, **Z** match, it means for the
38-
for the scenarios *1* and *2* that the library must be able to
39-
**read** but **not write** the file. (The addition of the Group
38+
If all components but the last, i.e **Z**, match, it means for the
39+
scenarios *1* and *2* that the library must be able to **read**
40+
but **not write** the file. (The addition of the Group
4041
entity or the DataFrame entity would be such a change.)
4142

4243
If X matches but **Y** is different, (1.) a new library (*NL*) must be

0 commit comments

Comments
 (0)