Skip to content

Commit

Permalink
More godoc improvements for #72
Browse files Browse the repository at this point in the history
  • Loading branch information
skx committed Nov 16, 2018
1 parent ef456f1 commit 1844b3f
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions eval/eval.go
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
// Package eval contains our evaluator
// Package eval contains the evaluator which executes the BASIC programs.
//
// This is pretty simple:
// The interpreter is intentionally simple:
//
// * The program is an array of tokens.
// 1. The input program is parsed into a series of tokens.
//
// * We have one statement per line.
// 2. Each token is executed sequentially.
//
// * We handle the different types of statements in their own functions.
// There are distinct handlers for each kind of built-in primitive such
// as REM, DATA, READ, etc. Things that could be pushed outside the core,
// such as the maths-primitives (SIN, COS, TAN, etc) have been moved into
// their own package to keep this as simple and readable as possible.
//
package eval

Expand Down

0 comments on commit 1844b3f

Please sign in to comment.