From 5545002d9238dc3f18e1dcc8ad575c255947e5b6 Mon Sep 17 00:00:00 2001 From: sammyette Date: Tue, 24 Dec 2024 18:53:34 -0400 Subject: [PATCH] fix: signature link in table of contents --- cmd/docgen/docgen.lua | 2 +- docs/api/hilbish/hilbish.runner.md | 27 +++++++-------------------- 2 files changed, 8 insertions(+), 21 deletions(-) diff --git a/cmd/docgen/docgen.lua b/cmd/docgen/docgen.lua index 50e777c..7468f3b 100644 --- a/cmd/docgen/docgen.lua +++ b/cmd/docgen/docgen.lua @@ -134,7 +134,7 @@ for iface, dps in pairs(pieces) do if tocPos then local pos = f:seek() f:seek('set', tocPos) - f:write(string.format('||%s|\n', func, docs.description[1])) + f:write(string.format('|%s|%s|\n', func, sig, docs.description[1])) tocPos = f:seek() f:seek('set', pos) end diff --git a/docs/api/hilbish/hilbish.runner.md b/docs/api/hilbish/hilbish.runner.md index 7fb18e9..244fb87 100644 --- a/docs/api/hilbish/hilbish.runner.md +++ b/docs/api/hilbish/hilbish.runner.md @@ -57,26 +57,13 @@ end) |setMode(cb)|This is the same as the `hilbish.runnerMode` function.| |lua(cmd)|Evaluates `cmd` as Lua input. This is the same as using `dofile`| |sh(cmd)|Runs a command in Hilbish's shell script interpreter.| -||Returns the current runner by name.| -||Sets the current interactive/command line runner mode.| -||Adds a runner to the table of available runners. If runner is a table,| -||Get a runner by name.| -||Sets a runner by name. The runner table must have the run function in it.| -||Executes cmd with a runner. If runnerName isn't passed, it uses| -### Parameters -`function` **`cb`** - - - - -
-
-

-hilbish.runner.lua(cmd) - - - -

+|hilbish.runner.getCurrent()|Returns the current runner by name.| +|hilbish.runner.setCurrent(name)|Sets the current interactive/command line runner mode.| +|hilbish.runner.add(name, runner)|Adds a runner to the table of available runners. If runner is a table,| +|hilbish.runner.get(name)|Get a runner by name.| +|hilbish.runner.set(name, runner)|Sets a runner by name. The runner table must have the run function in it.| +|hilbish.runner.exec(cmd, runnerName)|Executes cmd with a runner. If runnerName isn't passed, it uses| +> Evaluates `cmd` as Lua input. This is the same as using `dofile` or `load`, but is appropriated for the runner interface.