fix reference to old ls param in Lua API docs

also add another example to the ls example commands
develop
myk002 2022-09-11 14:06:21 -07:00
parent 55a8db4efb
commit 2311158792
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 10 additions and 8 deletions

@ -928,9 +928,9 @@ can be omitted.
The following examples are equivalent:: The following examples are equivalent::
dfhack.run_command({'ls', '-a'}) dfhack.run_command({'ls', 'quick'})
dfhack.run_command('ls', '-a') dfhack.run_command('ls', 'quick')
dfhack.run_command('ls -a') -- not recommended dfhack.run_command('ls quick') -- not recommended
* ``dfhack.run_command_silent(command[, ...])`` * ``dfhack.run_command_silent(command[, ...])``

@ -25,11 +25,13 @@ Usage
Examples Examples
-------- --------
- ``ls adventure`` ``ls quick``
Lists all commands with the ``adventure`` tag. List all commands that match the substring "quick".
- ``ls --dev trigger`` ``ls adventure``
Lists all commands, including developer and modding commands, that match the List all commands with the ``adventure`` tag.
substring "trigger" ``ls --dev trigger``
List all commands, including developer and modding commands, that match the
substring "trigger".
Options Options
------- -------