grain-lang.org icon indicating copy to clipboard operation
grain-lang.org copied to clipboard

Discussion: How should we document the language itself

Open phated opened this issue 5 years ago • 1 comments

Currently, not much of the language itself is documented on the website. I just found Bindings today and noticed that it has a pretty plain way of representing the language constructs for let bindings.

I wonder if there's a better and more clear way for us to document the actual language.

phated avatar Jul 16 '20 06:07 phated

I originally envisioned that section to just include the formal syntax for the construct, along with any additional information users should know about it, and maybe an example or two. I actually really like how Python does its language docs, and I think we should largely follow suit: https://docs.python.org/3/reference/lexical_analysis.html#identifiers

I made a lot of those pages a long time ago without much thought... I think this would be a good way to condense them and have useful info!

ospencer avatar Jul 18 '20 14:07 ospencer