Skip to content

Commit

Permalink
docs: move Hooks to Signals
Browse files Browse the repository at this point in the history
  • Loading branch information
TorchedSammy committed Dec 18, 2023
1 parent fb3915e commit 433ffa5
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/hooks/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Hooks
title: Signals
description:
layout: doc
weight: -50
menu:
docs
---

Hooks are Hilbish's versions of events, which are used via the [Bait](../api/bait) module.
For more detail on how to act on these hooks, you may check the Bait page.
Signals are global events emitted with the [Bait](../api/bait) module.
For more detail on how to use these signals, you may check the Bait page.
2 changes: 1 addition & 1 deletion docs/hooks/command.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description:
layout: doc
menu:
docs:
parent: "Hooks"
parent: "Signals"
---

- `command.preexec` -> input, cmdStr > Thrown before a command
Expand Down
2 changes: 1 addition & 1 deletion docs/hooks/hilbish.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description:
layout: doc
menu:
docs:
parent: "Hooks"
parent: "Signals"
---

+ `hilbish.exit` > Sent when Hilbish is about to exit.
Expand Down
2 changes: 1 addition & 1 deletion docs/hooks/signal.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description:
layout: doc
menu:
docs:
parent: "Hooks"
parent: "Signals"
---

+ `signal.sigint` > Sent when Hilbish receives SIGINT (on Ctrl-C).
Expand Down
4 changes: 2 additions & 2 deletions docs/nature/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ growing to their final phase: a full plant. A lot of Hilbish itself is
written in Go, but there are parts made in Lua, being most builtins
(`doc`, `cd`, cdr), completions, and other things.

Hilbish's Lua core module is called `nature`. It's handled after everything
on the Go side initializes, which is what that first sentence was from.
Hilbish's Lua core module is called `nature`.
It runs after Hilbish's Go core does.

# Nature Modules
Currently, `nature` provides 1 intended public module: `nature.dirs`.
Expand Down

0 comments on commit 433ffa5

Please sign in to comment.