Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Discussion: How should we document the language itself #82

Open
phated opened this issue Jul 16, 2020 · 1 comment
Open

Discussion: How should we document the language itself #82

phated opened this issue Jul 16, 2020 · 1 comment

Comments

@phated
Copy link
Member

phated commented Jul 16, 2020

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.

@ospencer
Copy link
Member

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants