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

Language Feature Document #73

Open
4 of 11 tasks
ballercat opened this issue Jan 28, 2018 · 4 comments
Open
4 of 11 tasks

Language Feature Document #73

ballercat opened this issue Jan 28, 2018 · 4 comments

Comments

@ballercat
Copy link
Owner

ballercat commented Jan 28, 2018

Goal

A user should be able to read through the features of a language.

Overview

Kind of hard to point others to specs etc., when trying to list out language features. Some of the early documentation is out of date on the wiki. We need an MD-file doc with all features clearly documented.

One thing of note is that, where possible, we can omit documentation for 1:1 JavaScript features. Like object access.

Acceptance Criteria

Think basic language doc, topics should be in the following order

  • Basic Types
  • Available Math operators
  • Control flow (list missing, switch)
  • Function declaration
  • Custom Function types
  • Exports, Imports
  • Walt custom types Table, Memory
  • Arrays and memory access
  • User-defined structs
  • Closures

Bonus points

  • Document what the syntax above is compiled to in WebAssembly opcodes!
@ballercat ballercat changed the title Language Feature Docuent Language Feature Document Jan 28, 2018
@JobLeonard
Copy link

One thing of note is that, where possible, we can omit documentation for 1:1 JavaScript features. Like object access.

I would argue that having a list telling us which features are 1:1 JavaScript is important, though

@ballercat
Copy link
Owner Author

Fair point. I can see how someone new to the project/idea would find such documentation important. Can be tough to remember that there is a knowledge gap when you work on a project like this for so long :)

@JobLeonard
Copy link

I know the feeling. And it's especially tricky since bridging that gap is exactly what documentation is for

@iddan
Copy link

iddan commented Mar 9, 2018

ReasonML docs are great example IMO

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

No branches or pull requests

3 participants