From 412d3924eb1dfe6a6efe232a9c996bdd6a0694aa Mon Sep 17 00:00:00 2001 From: Max Date: Mon, 29 Dec 2025 20:44:55 -0500 Subject: [PATCH] docs: document methods --- pkg/saccharine/parser.go | 1 + pkg/saccharine/stringify.go | 1 + pkg/saccharine/tokenizer.go | 2 +- 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/pkg/saccharine/parser.go b/pkg/saccharine/parser.go index e90c363..4a92e76 100644 --- a/pkg/saccharine/parser.go +++ b/pkg/saccharine/parser.go @@ -212,6 +212,7 @@ func parseStatement(i *TokenIterator) (ast.Statement, error) { } } +// Given a list of tokens, attempt to parse it into an syntax tree. func Parse(tokens []token.Token) (ast.Expression, error) { i := iterator.Of(tokens) diff --git a/pkg/saccharine/stringify.go b/pkg/saccharine/stringify.go index 67d985d..c710990 100644 --- a/pkg/saccharine/stringify.go +++ b/pkg/saccharine/stringify.go @@ -54,6 +54,7 @@ func stringifyClause(n *ast.Clause) string { return "{ " + stmts + Stringify(n.Returns) + " }" } +// Convert an expression back into valid source code. func Stringify(n ast.Expression) string { switch n := n.(type) { case *ast.Atom: diff --git a/pkg/saccharine/tokenizer.go b/pkg/saccharine/tokenizer.go index c0de4de..81c46dc 100644 --- a/pkg/saccharine/tokenizer.go +++ b/pkg/saccharine/tokenizer.go @@ -97,7 +97,7 @@ func getToken(i *iterator.Iterator[rune]) (*token.Token, error) { return nil, fmt.Errorf("unknown character '%v'", string(letter)) } -// Parses a list of runes into tokens. All error encountered are returned, as well. +// Parse a string into tokens. func GetTokens(input string) ([]token.Token, error) { i := iterator.Of([]rune(input)) tokens := []token.Token{}