diff --git a/docs/api/fs.md b/docs/api/fs.md index e2f0e62..3800422 100644 --- a/docs/api/fs.md +++ b/docs/api/fs.md @@ -1,11 +1,13 @@ --- name: Module fs -description: +description: filesystem interaction and functionality library layout: apidoc --- ## Introduction - +The fs module provides easy and simple access to filesystem functions +and other things, and acts an addition to the Lua standard library's +I/O and filesystem functions. ## Functions ### abs(path) diff --git a/docs/api/terminal.md b/docs/api/terminal.md index dacc879..f1007d8 100644 --- a/docs/api/terminal.md +++ b/docs/api/terminal.md @@ -1,11 +1,11 @@ --- name: Module terminal -description: +description: low level terminal library layout: apidoc --- ## Introduction - +The terminal library is a simple and lower level library for certain terminal interactions. ## Functions ### restoreState() diff --git a/golibs/fs/fs.go b/golibs/fs/fs.go index 5b12e73..94b8110 100644 --- a/golibs/fs/fs.go +++ b/golibs/fs/fs.go @@ -1,3 +1,7 @@ +// filesystem interaction and functionality library +// The fs module provides easy and simple access to filesystem functions +// and other things, and acts an addition to the Lua standard library's +// I/O and filesystem functions. package fs import ( diff --git a/golibs/terminal/terminal.go b/golibs/terminal/terminal.go index df1755c..4ae8f88 100644 --- a/golibs/terminal/terminal.go +++ b/golibs/terminal/terminal.go @@ -1,3 +1,5 @@ +// low level terminal library +// The terminal library is a simple and lower level library for certain terminal interactions. package terminal import (