Convert VIPs to markdown format.

master
François Pottier 2018-11-21 00:01:32 +01:00
parent 4cdcec5558
commit a2bc023128
2 changed files with 20 additions and 18 deletions

View File

@ -1,18 +0,0 @@
A "VIP" is a common syntax error, for which a good error message
should be given.
------------------------------------------------------------------------------
Everything that is allowed in a structure but forbidden in a signature,
or vice-versa, is a VIP. For instance, writing:
exception A = B
is allowed in a structure, but forbidden in a signature. (Here, we might
wish to make the error message depend on the lookahead token; the token
"=" suggests that the user confuses a structure and a signature.)
------------------------------------------------------------------------------
Similarly, writing "struct" where "sig" is expected, or vice-versa, is
probably a common mistake.

20
parsing/VIPs.md Normal file
View File

@ -0,0 +1,20 @@
# VIPs
A VIP is a common syntax error, for which a good error message should be
given.
## Structures versus signatures
Everything that is allowed in a structure but forbidden in a signature,
or vice-versa, is a VIP. For instance, writing:
```
exception A = B
```
is allowed in a structure, but forbidden in a signature. (Here, we might
wish to make the error message depend on the lookahead token; the token
`=` suggests that the user confuses a structure and a signature.)
Similarly, writing `struct` where `sig` is expected, or vice-versa, is
probably a common mistake.