Merge pull request #3113 from AndreasMatthias/fix/help

Chore: Update help messages

Author: sumneko

changelog.md

@@ -2,8 +2,9 @@
 
 ## Unreleased
 <!-- Add all new changes here. They will be moved under a version at release -->
-* `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
 

script/cli/help.lua

@@ -55,18 +55,27 @@ 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/]]
     },
     ['--doc_out_path'] = {
         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 = [[