From 38b909bb54fc28a7bb2aa37b58b7a31d4a805213 Mon Sep 17 00:00:00 2001 From: sammyette Date: Wed, 19 Mar 2025 22:09:49 -0400 Subject: [PATCH] fix: add table heading --- cmd/docgen/docgen.lua | 3 +++ docs/api/hilbish/hilbish.messages.md | 9 ++------- docs/api/hilbish/hilbish.runner.md | 6 ------ docs/nature/dirs.md | 7 ++----- docs/nature/doc.md | 5 ++--- 5 files changed, 9 insertions(+), 21 deletions(-) diff --git a/cmd/docgen/docgen.lua b/cmd/docgen/docgen.lua index 3a28926..e1e57d6 100644 --- a/cmd/docgen/docgen.lua +++ b/cmd/docgen/docgen.lua @@ -123,6 +123,9 @@ for iface, dps in pairs(pieces) do table.remove(descriptions[iface], 1) f:write(string.format('\n## Introduction\n%s\n\n', table.concat(descriptions[iface], '\n'))) f:write('## Functions\n') + f:write([[||| +|----|----| +]]) tocPos = f:seek() end end diff --git a/docs/api/hilbish/hilbish.messages.md b/docs/api/hilbish/hilbish.messages.md index 023b87c..2dff7a7 100644 --- a/docs/api/hilbish/hilbish.messages.md +++ b/docs/api/hilbish/hilbish.messages.md @@ -20,6 +20,8 @@ The `hilbish.message` type is a table with the following keys: `read` (boolean): Whether the full message has been read or not. ## Functions +||| +|----|----| |unreadCount()|Returns the amount of unread messages.| |readAll()|Marks all messages as read.| |send(message)|Sends a message.| @@ -27,7 +29,6 @@ The `hilbish.message` type is a table with the following keys: |delete(idx)|Deletes the message at `idx`.| |clear()|Deletes all messages.| |all()|Returns all messages.| -

@@ -42,7 +43,6 @@ Returns all messages. This function has no parameters.

-

@@ -57,7 +57,6 @@ Deletes all messages. This function has no parameters.

-

@@ -74,7 +73,6 @@ Deletes the message at `idx`.

-

@@ -91,7 +89,6 @@ Marks a message at `idx` as read.

-

@@ -108,7 +105,6 @@ Sends a message.

-

@@ -123,7 +119,6 @@ Marks all messages as read. This function has no parameters.

-

diff --git a/docs/api/hilbish/hilbish.runner.md b/docs/api/hilbish/hilbish.runner.md index 0bbc268..c4cfbe4 100644 --- a/docs/api/hilbish/hilbish.runner.md +++ b/docs/api/hilbish/hilbish.runner.md @@ -120,7 +120,6 @@ This is the equivalent of using `source`.

-

@@ -135,7 +134,6 @@ Returns the current runner by name. This function has no parameters.

-

@@ -152,7 +150,6 @@ Sets Hilbish's runner mode by name.

-

@@ -173,7 +170,6 @@ If runner is a table, it must have the run function in it.

-

@@ -190,7 +186,6 @@ Get a runner by name.

-

@@ -212,7 +207,6 @@ The runner table must have the run function in it.

-

diff --git a/docs/nature/dirs.md b/docs/nature/dirs.md index d2dc5d0..e49247c 100644 --- a/docs/nature/dirs.md +++ b/docs/nature/dirs.md @@ -13,12 +13,13 @@ The dirs module defines a small set of functions to store and manage directories. ## Functions +||| +|----|----| |recent(idx)|Get entry from recent directories list based on index.| |pop(num)|Remove the specified amount of dirs from the recent directories list.| |peak(num)|Look at `num` amount of recent directories, starting from the latest.| |push(dir)|Add `dir` to the recent directories list.| |setOld(d)|Sets the old directory string.| -

@@ -35,7 +36,6 @@ Sets the old directory string.

-

@@ -52,7 +52,6 @@ Add `dir` to the recent directories list.

-

@@ -70,7 +69,6 @@ This returns a table of recent directories, up to the `num` amount.

-

@@ -87,7 +85,6 @@ Remove the specified amount of dirs from the recent directories list.

-

diff --git a/docs/nature/doc.md b/docs/nature/doc.md index bbad7b2..6a2ca48 100644 --- a/docs/nature/doc.md +++ b/docs/nature/doc.md @@ -15,10 +15,11 @@ This is only documented for the sake of it. It's only intended use is by the Greenhouse pager. ## Functions +||| +|----|----| |renderCodeBlock(text)|Assembles and renders a code block. This returns| |highlight(text)|Performs basic Lua code highlighting.| |renderInfoBlock(type, text)|Renders an info block. An info block is a block of text with| -

@@ -39,7 +40,6 @@ an icon and styled text block.

-

@@ -56,7 +56,6 @@ Performs basic Lua code highlighting.

-