diff --git a/cmd/docgen/docgen.lua b/cmd/docgen/docgen.lua
index 5c7d155..62c4619 100644
--- a/cmd/docgen/docgen.lua
+++ b/cmd/docgen/docgen.lua
@@ -49,10 +49,14 @@ for _, fname in ipairs(files) do
if emmy then
if emmy == 'param' then
+ print('bruh', emmythings[1], emmythings[2])
table.insert(dps.params, 1, {
name = emmythings[1],
- type = emmythings[2]
+ type = emmythings[2],
+ -- the +1 accounts for space.
+ description = table.concat(emmythings, ' '):sub(emmythings[1]:len() + 1 + emmythings[2]:len() + 1)
})
+ print(table.concat(emmythings, '/'))
end
else
table.insert(dps.description, 1, docline)
@@ -160,7 +164,8 @@ for iface, dps in pairs(pieces) do
f:write 'This function has no parameters. \n'
end
for _, param in ipairs(docs.params) do
- f:write(string.format('`%s` **`%s`**\n', param.name:gsub('%?$', ''), param.type))
+ f:write(string.format('`%s` **`%s`** \n', param.name:gsub('%?$', ''), param.type))
+ f:write(string.format('%s\n\n', param.description))
end
--[[
local params = table.filter(docs, function(t)
diff --git a/docs/api/hilbish/hilbish.messages.md b/docs/api/hilbish/hilbish.messages.md
index 1e37205..4c72d3a 100644
--- a/docs/api/hilbish/hilbish.messages.md
+++ b/docs/api/hilbish/hilbish.messages.md
@@ -105,3 +105,1214 @@ hilbish.messages.unreadCount()
This function has no parameters.
+
+
+
+hilbish.messages.all()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.clear()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.delete()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.read()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.send(message)
+
+
+
+
+
+Sends a message.
+#### Parameters
+`message` **`hilbish.message`**
+
+
+
+
+hilbish.messages.readAll()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.unreadCount()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.all()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.clear()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.delete()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.read()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.send(message)
+
+
+
+
+
+Sends a message.
+#### Parameters
+`message` **`hilbish.message`**
+
+
+
+hilbish.messages.readAll()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.unreadCount()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.all()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.clear()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.delete(idx)
+
+
+
+
+
+Deletes the message at `idx`.
+#### Parameters
+`idx` **`number`**
+
+
+
+hilbish.messages.read()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.send(message)
+
+
+
+
+
+Sends a message.
+#### Parameters
+`message` **`hilbish.message`**
+
+
+
+hilbish.messages.readAll()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.unreadCount()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.all()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.clear()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.delete(idx)
+
+
+
+
+
+Deletes the message at `idx`.
+#### Parameters
+`idx` **`number`**
+r
+
+
+
+
+hilbish.messages.read()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.send(message)
+
+
+
+
+
+Sends a message.
+#### Parameters
+`message` **`hilbish.message`**
+e
+
+
+
+
+hilbish.messages.readAll()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.unreadCount()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.all()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.clear()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.delete(idx)
+
+
+
+
+
+Deletes the message at `idx`.
+#### Parameters
+`idx` **`number`**
+r
+
+
+
+
+hilbish.messages.read()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.send(message)
+
+
+
+
+
+Sends a message.
+#### Parameters
+`message` **`hilbish.message`**
+e
+
+
+
+
+hilbish.messages.readAll()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.unreadCount()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.all()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.clear()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.delete(idx)
+
+
+
+
+
+Deletes the message at `idx`.
+#### Parameters
+`idx` **`number`**
+r
+
+
+
+
+hilbish.messages.read()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.send(message)
+
+
+
+
+
+Sends a message.
+#### Parameters
+`message` **`hilbish.message`**
+e
+
+
+
+
+hilbish.messages.readAll()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.unreadCount()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.all()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.clear()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.delete(idx)
+
+
+
+
+
+Deletes the message at `idx`.
+#### Parameters
+`idx` **`number`**
+r
+
+
+
+
+hilbish.messages.read()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.send(message)
+
+
+
+
+
+Sends a message.
+#### Parameters
+`message` **`hilbish.message`**
+e
+
+
+
+
+hilbish.messages.readAll()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.unreadCount()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.all()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.clear()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.delete(idx)
+
+
+
+
+
+Deletes the message at `idx`.
+#### Parameters
+`idx` **`number`**
+r
+
+
+
+
+hilbish.messages.read()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.send(message)
+
+
+
+
+
+Sends a message.
+#### Parameters
+`message` **`hilbish.message`**
+e
+
+
+
+
+hilbish.messages.readAll()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.unreadCount()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.all()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.clear()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.delete(idx)
+
+
+
+
+
+Deletes the message at `idx`.
+#### Parameters
+`idx` **`number`**
+r
+
+
+
+
+hilbish.messages.read()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.send(message)
+
+
+
+
+
+Sends a message.
+#### Parameters
+`message` **`hilbish.message`**
+e
+
+
+
+
+hilbish.messages.readAll()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.unreadCount()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.all()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.clear()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.delete(idx)
+
+
+
+
+
+Deletes the message at `idx`.
+#### Parameters
+`idx` **`number`**
+
+
+
+
+
+hilbish.messages.read()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.send(message)
+
+
+
+
+
+Sends a message.
+#### Parameters
+`message` **`hilbish.message`**
+
+
+
+
+
+hilbish.messages.readAll()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.unreadCount()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.all()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.clear()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.delete(idx)
+
+
+
+
+
+Deletes the message at `idx`.
+#### Parameters
+`idx` **`number`**
+
+
+
+
+
+hilbish.messages.read()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.send(message)
+
+
+
+
+
+Sends a message.
+#### Parameters
+`message` **`hilbish.message`**
+
+
+
+
+
+hilbish.messages.readAll()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.unreadCount()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.all()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.clear()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.delete()
+
+
+
+
+
+Deletes the message at `idx`.
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.read()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.send(message)
+
+
+
+
+
+Sends a message.
+#### Parameters
+`message` **`hilbish.message`**
+
+
+
+
+
+hilbish.messages.readAll()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
+
+
+hilbish.messages.unreadCount()
+
+
+
+
+
+
+#### Parameters
+This function has no parameters.
+
@@ -160,8 +162,12 @@ hilbish.runner.add(name, runner)
Adds a runner to the table of available runners. If runner is a table,
it must have the run function in it.
#### Parameters
-`name` **`string`**
-`runner` **`function`**
+`name` **`string`**
+
+
+`runner` **`function|table`**
+
+
@@ -175,7 +181,9 @@ hilbish.runner.get(name)
Get a runner by name.
#### Parameters
-`name` **`string`**
+`name` **`string`**
+
+
@@ -189,8 +197,12 @@ hilbish.runner.set(name, runner)
Sets a runner by name. The runner table must have the run function in it.
#### Parameters
-`name` **`string`**
-`runner` **`table`**
+`name` **`string`**
+
+
+`runner` **`table`**
+
+
@@ -205,7 +217,11 @@ hilbish.runner.exec(cmd, runnerName)
Executes cmd with a runner. If runnerName isn't passed, it uses
the user's current runner.
#### Parameters
-`cmd` **`string`**
-`runnerName` **`string?`**
+`cmd` **`string`**
+
+
+`runnerName` **`string?`**
+
+
diff --git a/docs/nature/dirs.md b/docs/nature/dirs.md
index 2a0e966..b658c98 100644
--- a/docs/nature/dirs.md
+++ b/docs/nature/dirs.md
@@ -18,7 +18,9 @@ dirs.setOld(d)
Sets the old directory string.
#### Parameters
-`d` **`string`**
+`d` **`string`**
+
+
@@ -46,7 +48,9 @@ dirs.peak(num)
Look at `num` amount of recent directories, starting from the latest.
#### Parameters
-`num` **`number`**
+`num` **`number`**
+
+
@@ -60,7 +64,9 @@ dirs.pop(num)
Remove the specified amount of dirs from the recent directories list.
#### Parameters
-`num` **`number`**
+`num` **`number`**
+
+
@@ -74,6 +80,8 @@ dirs.recent(idx)
Get entry from recent directories list based on index.
#### Parameters
-`idx` **`number`**
+`idx` **`number`**
+
+
diff --git a/nature/hummingbird.lua b/nature/hummingbird.lua
index 271c3cf..058353d 100644
--- a/nature/hummingbird.lua
+++ b/nature/hummingbird.lua
@@ -53,7 +53,7 @@ function hilbish.messages.read(idx)
end
end
-function hilbish.messages.readAll(idx)
+function hilbish.messages.readAll()
for _, msg in ipairs(hilbish.messages.all()) do
hilbish.messages.read(msg.index)
end
@@ -63,6 +63,7 @@ function hilbish.messages.unreadCount()
return unread
end
+--- Deletes the message at `idx`.
function hilbish.messages.delete(idx)
local msg = M._messages[idx]
if not msg then
diff --git a/nature/runner.lua b/nature/runner.lua
index 0725810..8e3dfb8 100644
--- a/nature/runner.lua
+++ b/nature/runner.lua
@@ -21,7 +21,7 @@ end
--- Adds a runner to the table of available runners. If runner is a table,
--- it must have the run function in it.
--- @param name string
---- @param runner function | table
+--- @param runner function|table
function hilbish.runner.add(name, runner)
if type(name) ~= 'string' then
error 'expected runner name to be a table'