Skip to content

Commit ce0a1ad

Browse files
authored
Update the README
1 parent 29f2732 commit ce0a1ad

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,10 +150,12 @@ Having a well-defined semantics of the macros, you can write an FFI which is qui
150150
<otherwise> ::= "otherwise" <stmt> ;
151151
```
152152

153-
Notes:
154-
155-
- Each listed identifier in the above grammar corresponds to a macro name defined in `datatype99.h` by default -- these are called _shortened versions_. On the other hand, there are also _postfixed versions_ (`match99`, `of99`, `derive99`, etc.), which are defined unconditionally. If you want to avoid name clashes caused by shortened versions, define `DATATYPE99_NO_ALIASES` before including `datatype99.h`. Library headers are strongly advised to use the postfixed macros, but without resorting to `DATATYPE99_NO_ALIASES`.
153+
<details>
154+
<summary>Note: shortened vs. postfixed versions</summary>
156155

156+
Each listed identifier in the above grammar corresponds to a macro name defined by default -- these are called _shortened versions_. On the other hand, there are also _postfixed versions_ (`match99`, `of99`, `derive99`, etc.), which are defined unconditionally. If you want to avoid name clashes caused by shortened versions, define `DATATYPE99_NO_ALIASES` before including `datatype99.h`. Library headers are strongly advised to use the postfixed macros, but without resorting to `DATATYPE99_NO_ALIASES`.
157+
</details>
158+
157159
### Semantics
158160

159161
(It might be helpful to look at the [generated data layout](https://godbolt.org/z/3TKn8T3Gj) of [`examples/binary_tree.c`](examples/binary_tree.c).)

0 commit comments

Comments
 (0)