CakeML / CakeML/cakeml

Pancake annotation positions

Open
#1,135 0 comments 0 reactions 0 assignees View on GitHub
Pancake
Dominant language
Standard ML
Stars
1.2k
Forks
104
Avg merge
2d 21h
Merged PRs (30d)
16

Description

From a pure usability perspective, the current annotations have to sit inside a function body or a loop body like:
```c
fun main() {
/@ requires ... @/
/@ ensures ... @/

// blah..

while {
/@ invariant .. @/
}

}
```
which works as it is; but a bit counter-intuitive. A nicer way would be to put the annotations outside the bodies.

Contributor guide

No contributing guide indexed for this repository

Research direction

No file, test, or entry point is named. First clarify the desired syntax and how requires, ensures, and invariant annotations should relate to function and loop bodies; done means an agreed design is implemented and its behavior is covered by tests.

Written by the indexing model from the issue text.

Assessment

Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.