FStarLang / FStarLang/FStar

Syntax reference

Open
#680 4 comments 0 reactions 0 assignees View on GitHub
area/syntax component/documentation kind/enhancement priority/low status/needs-input
Dominant language
F*
Stars
3.1k
Forks
266
Avg merge
21h 1m
Merged PRs (30d)
54

Description

I'm trying to define syntax highlighting in Atom, and to that end I need to know which keywords are reserved, and whether or not they are positional.

For example, consider

`private let my_var' = 7`

one needs to know that `let` precedes a function name, and may itself be preceded by the modifier `private`.

src/parser and src/syntax both seem to define a syntax. Which should I use?

Contributor guide

Open the contributing guide

Research direction

Compare the syntax definitions in src/parser and src/syntax, starting with how each represents declarations such as `private let my_var' = 7`. Determine which source is authoritative for Atom syntax highlighting, then document the reserved and positional keyword information needed to describe the syntax reference.

Written by the indexing model from the issue text.

Assessment

Domain
compilers, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.