From 433ffa50685488da0618589f47f44f700eae3e71 Mon Sep 17 00:00:00 2001 From: sammyette Date: Mon, 18 Dec 2023 13:33:05 -0400 Subject: [PATCH] docs: move Hooks to Signals --- docs/hooks/_index.md | 6 +++--- docs/hooks/command.md | 2 +- docs/hooks/hilbish.md | 2 +- docs/hooks/signal.md | 2 +- docs/nature/_index.md | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/hooks/_index.md b/docs/hooks/_index.md index bb23477..ec313c6 100644 --- a/docs/hooks/_index.md +++ b/docs/hooks/_index.md @@ -1,5 +1,5 @@ --- -title: Hooks +title: Signals description: layout: doc weight: -50 @@ -7,5 +7,5 @@ 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. diff --git a/docs/hooks/command.md b/docs/hooks/command.md index ee47db7..d9bd610 100644 --- a/docs/hooks/command.md +++ b/docs/hooks/command.md @@ -4,7 +4,7 @@ description: layout: doc menu: docs: - parent: "Hooks" + parent: "Signals" --- - `command.preexec` -> input, cmdStr > Thrown before a command diff --git a/docs/hooks/hilbish.md b/docs/hooks/hilbish.md index b240683..05e6fa4 100644 --- a/docs/hooks/hilbish.md +++ b/docs/hooks/hilbish.md @@ -4,7 +4,7 @@ description: layout: doc menu: docs: - parent: "Hooks" + parent: "Signals" --- + `hilbish.exit` > Sent when Hilbish is about to exit. diff --git a/docs/hooks/signal.md b/docs/hooks/signal.md index 317ab79..5cd9876 100644 --- a/docs/hooks/signal.md +++ b/docs/hooks/signal.md @@ -4,7 +4,7 @@ description: layout: doc menu: docs: - parent: "Hooks" + parent: "Signals" --- + `signal.sigint` > Sent when Hilbish receives SIGINT (on Ctrl-C). diff --git a/docs/nature/_index.md b/docs/nature/_index.md index 460d6a3..4a3bc35 100644 --- a/docs/nature/_index.md +++ b/docs/nature/_index.md @@ -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`.