lang: interfaces: Expand docs on compiler constants

Improve the docs to make things clearer.
This commit is contained in:
James Shubin
2024-01-07 17:16:10 -05:00
parent 837739d7dd
commit acae7eccc4

View File

@@ -20,10 +20,12 @@ package interfaces
const ( const (
// ModuleSep is the character used for the module scope separation. For // ModuleSep is the character used for the module scope separation. For
// example when using `fmt.printf` or `math.sin` this is the char used. // example when using `fmt.printf` or `math.sin` this is the char used.
// It is also used for variable scope separation such as `$foo.bar.baz`.
ModuleSep = "." ModuleSep = "."
// VarPrefix is the prefix character that precedes the variables // VarPrefix is the prefix character that precedes the variables
// identifier. For example, `$foo` or for a lambda, `$fn(42)`. // identifier. For example, `$foo` or for a lambda, `$fn(42)`. It is
// also used with `ModuleSep` for scoped variables like `$foo.bar.baz`.
VarPrefix = "$" VarPrefix = "$"
// PanicResKind is the kind string used for the panic resource. // PanicResKind is the kind string used for the panic resource.