mirror of https://github.com/Hilbis/Hilbish
docs: make linebreaks to descriptions for better alignment
parent
784e611272
commit
bd3e9fdca6
|
@ -23,8 +23,12 @@ func (b *Bait) Loader(L *lua.LState) int {
|
||||||
L.SetField(mod, "throw", luar.New(L, b.bthrow))
|
L.SetField(mod, "throw", luar.New(L, b.bthrow))
|
||||||
L.SetField(mod, "catch", luar.New(L, b.bcatch))
|
L.SetField(mod, "catch", luar.New(L, b.bcatch))
|
||||||
|
|
||||||
util.Document(L, mod, `Bait is the event emitter for Hilbish. Why name it bait? Because it throws hooks that you can catch. (emits events that you can listen to) and because why not, fun naming is fun.
|
util.Document(L, mod, `Bait is the event emitter for Hilbish. Why name it bait?
|
||||||
This is what you will use if you want to listen in on hooks to know when certain things have happened, like when you've changed directory, a command has failed, etc.`)
|
Because it throws hooks that you can catch
|
||||||
|
(emits events that you can listen to) and because why not,
|
||||||
|
fun naming is fun. This is what you will use if you want to
|
||||||
|
listen in on hooks to know when certain things have happened,
|
||||||
|
like when you've changed directory, a command has failed, etc.`)
|
||||||
L.Push(mod)
|
L.Push(mod)
|
||||||
|
|
||||||
return 1
|
return 1
|
||||||
|
|
|
@ -3,7 +3,6 @@
|
||||||
package fs
|
package fs
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
|
||||||
"os"
|
"os"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
@ -15,8 +14,9 @@ import (
|
||||||
func Loader(L *lua.LState) int {
|
func Loader(L *lua.LState) int {
|
||||||
mod := L.SetFuncs(L.NewTable(), exports)
|
mod := L.SetFuncs(L.NewTable(), exports)
|
||||||
|
|
||||||
util.Document(L, mod, `The fs module provides easy and simple access to filesystem functions and other
|
util.Document(L, mod, `The fs module provides easy and simple access to
|
||||||
things, and acts an addition to the Lua standard library's I/O and fs functions.`)
|
filesystem functions and other things, and acts an
|
||||||
|
addition to the Lua standard library's I/O and fs functions.`)
|
||||||
|
|
||||||
L.Push(mod)
|
L.Push(mod)
|
||||||
return 1
|
return 1
|
||||||
|
|
Loading…
Reference in New Issue