From e044aeb5edceeb4a79cf625ee0693f85f1f1b5d7 Mon Sep 17 00:00:00 2001 From: TorchedSammy Date: Wed, 13 Apr 2022 14:14:06 +0000 Subject: [PATCH] docs: [ci] generate new docs --- docs/hilbish.txt | 2 +- emmyLuaDocs/hilbish.lua | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/hilbish.txt b/docs/hilbish.txt index 4f13339..e86af79 100644 --- a/docs/hilbish.txt +++ b/docs/hilbish.txt @@ -35,7 +35,7 @@ multiprompt(str) > Changes the continued line prompt to `str` prependPath(dir) > Prepends `dir` to $PATH -prompt(str) > Changes the shell prompt to `str` +prompt(str, typ?) > Changes the shell prompt to `str` There are a few verbs that can be used in the prompt text. These will be formatted and replaced with the appropriate values. `%d` - Current working directory diff --git a/emmyLuaDocs/hilbish.lua b/emmyLuaDocs/hilbish.lua index b49dc05..f8c4380 100644 --- a/emmyLuaDocs/hilbish.lua +++ b/emmyLuaDocs/hilbish.lua @@ -73,7 +73,8 @@ function hilbish.prependPath(dir) end --- `%u` - Name of current user --- `%h` - Hostname of device --- @param str string -function hilbish.prompt(str) end +--- @param typ string Type of prompt, being left or right. Left by default. +function hilbish.prompt(str, typ) end --- Read input from the user, using Hilbish's line editor/input reader. --- This is a separate instance from the one Hilbish actually uses.