docs: add descriptions for terminal and fs libs

docs-refactor
TorchedSammy 2022-12-02 17:06:53 -04:00
parent 9df0c4c0df
commit 4b5fcf24c2
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
4 changed files with 12 additions and 4 deletions

View File

@ -1,11 +1,13 @@
--- ---
name: Module fs name: Module fs
description: description: filesystem interaction and functionality library
layout: apidoc layout: apidoc
--- ---
## Introduction ## 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 ## Functions
### abs(path) ### abs(path)

View File

@ -1,11 +1,11 @@
--- ---
name: Module terminal name: Module terminal
description: description: low level terminal library
layout: apidoc layout: apidoc
--- ---
## Introduction ## Introduction
The terminal library is a simple and lower level library for certain terminal interactions.
## Functions ## Functions
### restoreState() ### restoreState()

View File

@ -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 package fs
import ( import (

View File

@ -1,3 +1,5 @@
// low level terminal library
// The terminal library is a simple and lower level library for certain terminal interactions.
package terminal package terminal
import ( import (