ocaml-gospel / gospel

A tool-agnostic formal specification language for OCaml.
https://ocaml-gospel.github.io/gospel
MIT License
128 stars 16 forks source link

Add a test that shows the issue of misplaced Gospel comments #348

Closed shym closed 1 year ago

shym commented 1 year ago

As Gospel special comments are turned into attributes, if they are placed at positions at which the OCaml syntax does not accept attributes, they will be reported as syntax errors, which might be confusing to new users.

It might be useful to mention this fact also in the documentation page explaining the Gospel special comments.

shym commented 1 year ago

This is to keep track of the issue reported in #337 in the test suite.