From c121356e0fd5c35c43d0d4bd63959601d8eee4f4 Mon Sep 17 00:00:00 2001 From: sammyette Date: Wed, 2 Apr 2025 21:42:45 -0400 Subject: [PATCH] docs: fix snail docs --- cmd/docgen/docgen.go | 5 +++ docs/api/snail.md | 87 +++---------------------------------------- emmyLuaDocs/snail.lua | 15 -------- golibs/snail/lua.go | 10 ++--- 4 files changed, 16 insertions(+), 101 deletions(-) diff --git a/cmd/docgen/docgen.go b/cmd/docgen/docgen.go index eb42ce1..368b1a9 100644 --- a/cmd/docgen/docgen.go +++ b/cmd/docgen/docgen.go @@ -84,6 +84,7 @@ var prefix = map[string]string{ "commander": "c", "bait": "b", "terminal": "term", + "snail": "snail", } func getTagsAndDocs(docs string) (map[string][]tag, []string) { @@ -209,6 +210,10 @@ func setupDocType(mod string, typ *doc.Type) *docPiece { } func setupDoc(mod string, fun *doc.Func) *docPiece { + if fun.Doc == "" { + return nil + } + docs := strings.TrimSpace(fun.Doc) tags, parts := getTagsAndDocs(docs) diff --git a/docs/api/snail.md b/docs/api/snail.md index 44847a9..e5dcb6d 100644 --- a/docs/api/snail.md +++ b/docs/api/snail.md @@ -9,101 +9,26 @@ menu: ## Introduction - The snail library houses Hilbish's Lua wrapper of its shell script interpreter. - It's not very useful other than running shell scripts, which can be done with other - Hilbish functions. +The snail library houses Hilbish's Lua wrapper of its shell script interpreter. +It's not very useful other than running shell scripts, which can be done with other +Hilbish functions. ## Functions ||| |----|----| -||| -||| -||| -|new() -> @Snail|Creates a new Snail instance.| -||| -||| +|new() -> @Snail|Creates a new Snail instance.|
-
-

-snail. - - - -

- - -#### Parameters -This function has no parameters. -
- -
-
-

-snail. - - - -

- - -#### Parameters -This function has no parameters. -
- -
-
-

-snail. - - - -

- - -#### Parameters -This function has no parameters. -
- -
-
+

snail.new() -> Snail - +

Creates a new Snail instance. -#### Parameters -This function has no parameters. -
- -
-
-

-snail. - - - -

- - -#### Parameters -This function has no parameters. -
- -
-
-

-snail. - - - -

- - #### Parameters This function has no parameters.
diff --git a/emmyLuaDocs/snail.lua b/emmyLuaDocs/snail.lua index f06a2e1..331a1ff 100644 --- a/emmyLuaDocs/snail.lua +++ b/emmyLuaDocs/snail.lua @@ -2,25 +2,10 @@ local snail = {} ---- -function snail. end - ---- -function snail. end - ---- -function snail. end - --- Creates a new Snail instance. function snail.new() end ---- -function snail. end - --- Runs a shell command. Works the same as `hilbish.run`. function snail:run(command, streams) end ---- -function snail. end - return snail diff --git a/golibs/snail/lua.go b/golibs/snail/lua.go index 37357e5..18d1fc1 100644 --- a/golibs/snail/lua.go +++ b/golibs/snail/lua.go @@ -1,8 +1,8 @@ // shell script interpreter library /* - The snail library houses Hilbish's Lua wrapper of its shell script interpreter. - It's not very useful other than running shell scripts, which can be done with other - Hilbish functions. +The snail library houses Hilbish's Lua wrapper of its shell script interpreter. +It's not very useful other than running shell scripts, which can be done with other +Hilbish functions. */ package snail @@ -56,7 +56,7 @@ func loaderFunc(rtm *rt.Runtime) (rt.Value, func()) { // new() -> @Snail // Creates a new Snail instance. -func snew(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { +func snailnew(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { s := New(t.Runtime) return c.PushingNext1(t.Runtime, rt.UserDataValue(snailUserData(s))), nil } @@ -64,7 +64,7 @@ func snew(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // #member // run(command, streams) // Runs a shell command. Works the same as `hilbish.run`. -func srun(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { +func snailrun(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.CheckNArgs(2); err != nil { return nil, err }