From d791de76eeb68ce31d837916b49d2efab507b354 Mon Sep 17 00:00:00 2001 From: Andreas Matthias Date: Tue, 18 Feb 2025 00:53:49 +0100 Subject: [PATCH] Chore: Update help messages --- changelog.md | 1 + script/cli/help.lua | 11 ++++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/changelog.md b/changelog.md index 3906c762a..440d48a4a 100644 --- a/changelog.md +++ b/changelog.md @@ -2,6 +2,7 @@ ## Unreleased +* `FIX` Update `--help` message. ## 3.13.7 `2025-3-10` diff --git a/script/cli/help.lua b/script/cli/help.lua index 6aa218afc..6ab813912 100644 --- a/script/cli/help.lua +++ b/script/cli/help.lua @@ -55,7 +55,8 @@ local args = { type = 'string', description = [[ Generate documentation from a workspace. - The files will be output in your log path. + The files will be written to the documentation output path passed + in --doc_out_path. ]], example = [[--doc=C:/Users/Me/Documents/myLuaProject/]] }, @@ -63,10 +64,18 @@ local args = { type = 'string', description = [[ The path to output generated documentation at. + If --doc_out_path is missing, the documentation will be written + to the current directory. See --doc for more info. ]], example = [[--doc_out_path=C:/Users/Me/Documents/myLuaProjectDocumentation]] }, + ['--doc_update'] = { + type = 'string', + description = [[ + Update existing documentation files at the given path. + ]] + }, ['--logpath'] = { type = 'string', description = [[