ballercat/walt

Language Feature Document

Open

#73 opened on Jan 28, 2018

View on GitHub
 (4 comments) (2 reactions) (0 assignees)JavaScript (4,637 stars) (155 forks)batch import
docsgood first issuehelp wanted

Description

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!

Contributor guide

Tech stack
javascriptwasm
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of Walt syntaxunderstanding of WebAssembly fundamentals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the existing Walt documentation (wiki and source code) to understand current state. Then fill in the missing sections from the checklist. Pay attention to the note that 1:1 JavaScript features can be omitted. The bonus section about WebAssembly opcodes may require deeper knowledge; consider tackling it after the main items.