godoc for extra packages

config/config.go

@@ -24,6 +24,10 @@ import (
     "gitlab.com/whom/shs/stdlib"
 )
 
+/* creates new VarTable and FuncTable
+ * reads a configuration file
+ * executes contents and returns tables
+ */
 func InitFromConfig(configFile string) (ast.VarTable, ast.FuncTable) {
     funcs := stdlib.GenFuncTable()
     vars := &map[string]*ast.Token{}

log/logger.go

@@ -29,16 +29,23 @@ const (
 
 var logLevel int64
 
+/* Set the log level from 0 to 4
+ * currently only 0, 1, and 2 are used.
+ */
 func SetLogLvl(lvl int64) {
     if lvl < 4 && lvl > 0 {
         logLevel = lvl
     }
 }
 
+/* get current log level as int
+ */
 func GetLogLvl() int64 {
     return logLevel
 }
 
+/* writes a message to the log
+ */
 func Log(lvl int, msg, context string) {
     if int64(lvl) > logLevel {
         return

util/scripts.go

@@ -24,6 +24,8 @@ import (
     "gitlab.com/whom/shs/ast"
 )
 
+/* Opens a file and lexes+evaluates the contents
+ */
 func LoadScript(path string, vt ast.VarTable, ft ast.FuncTable) {
     scriptFile, err := os.Open(path)
     if err != nil {

util/shell_complete.go

@@ -24,8 +24,10 @@ import (
     "gitlab.com/whom/shs/ast"
 )
 
-// wrap this in a lambda that passes in the vt and ft
-// I suppose it could be more optimal. Fix if it bothers you
+/* gathers completions for the last word in a given line
+ * shell wraps this in a lambda that passes in the vt and ft
+ * I suppose it could be more optimal. Fix if it bothers you
+ */
 func ShellCompleter(line string, vt ast.VarTable, ft ast.FuncTable) []string {
     var head, tail string