Skip to content

Commit

Permalink
docs: [ci] generate new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TorchedSammy authored and github-actions[bot] committed Apr 28, 2024
1 parent 42ab856 commit d46c079
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/api/commander.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ This sink is for writing errors, as the name would suggest.
|----|----|
|<a href="#deregister">deregister(name)</a>|Removes the named command. Note that this will only remove Commander-registered commands.|
|<a href="#register">register(name, cb)</a>|Adds a new command with the given `name`. When Hilbish has to run a command with a name,|
|<a href="#registry">registry() -> table</a>|Returns all registered commanders. Returns a list of tables with the following keys:|

<hr>
<div id='deregister'>
Expand Down Expand Up @@ -94,3 +95,19 @@ end)
```
</div>

<hr>
<div id='registry'>
<h4 class='heading'>
commander.registry() -> table
<a href="#registry" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>

Returns all registered commanders. Returns a list of tables with the following keys:
- `exec`: The function used to run the commander. Commanders require args and sinks to be passed.

#### Parameters
This function has no parameters.
</div>

4 changes: 4 additions & 0 deletions emmyLuaDocs/commander.lua
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,8 @@ function commander.deregister(name) end
---
function commander.register(name, cb) end

--- Returns all registered commanders. Returns a list of tables with the following keys:
--- - `exec`: The function used to run the commander. Commanders require args and sinks to be passed.
function commander.registry() end

return commander

0 comments on commit d46c079

Please sign in to comment.