From 23111587923cc61fa2de17c8e7be2f2ccaa2e140 Mon Sep 17 00:00:00 2001 From: myk002 Date: Sun, 11 Sep 2022 14:06:21 -0700 Subject: [PATCH] fix reference to old ls param in Lua API docs also add another example to the ls example commands --- docs/Lua API.rst | 6 +++--- docs/builtins/ls.rst | 12 +++++++----- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/Lua API.rst b/docs/Lua API.rst index 71094414f..3742b0851 100644 --- a/docs/Lua API.rst +++ b/docs/Lua API.rst @@ -928,9 +928,9 @@ can be omitted. The following examples are equivalent:: - dfhack.run_command({'ls', '-a'}) - dfhack.run_command('ls', '-a') - dfhack.run_command('ls -a') -- not recommended + dfhack.run_command({'ls', 'quick'}) + dfhack.run_command('ls', 'quick') + dfhack.run_command('ls quick') -- not recommended * ``dfhack.run_command_silent(command[, ...])`` diff --git a/docs/builtins/ls.rst b/docs/builtins/ls.rst index 6b21e4b53..7305a0256 100644 --- a/docs/builtins/ls.rst +++ b/docs/builtins/ls.rst @@ -25,11 +25,13 @@ Usage Examples -------- -- ``ls adventure`` - Lists all commands with the ``adventure`` tag. -- ``ls --dev trigger`` - Lists all commands, including developer and modding commands, that match the - substring "trigger" +``ls quick`` + List all commands that match the substring "quick". +``ls adventure`` + List all commands with the ``adventure`` tag. +``ls --dev trigger`` + List all commands, including developer and modding commands, that match the + substring "trigger". Options -------