diff --git a/changelog.md b/changelog.md index 5f76cb235..628e35c48 100644 --- a/changelog.md +++ b/changelog.md @@ -2,8 +2,9 @@ ## Unreleased -* `CHG` When analyzing the literal table, only the first 100 items are analyzed at most. -* `CHG` When checking type matching for union types, only the first 100 items are checked at most. +* `CHG` when analyzing the literal table, only the first 100 items are analyzed at most +* `CHG` when checking type matching for union types, only the first 100 items are checked at most +* `FIX` Update `--help` message. * `FIX` --check now respects ignoreDir setting * `FIX` incorrect argument skip pattern for `--check_out_path=`, which incorrectly skips the next argument 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 = [[