From f77a7d51887582f265da6b925e488227b9cf3e29 Mon Sep 17 00:00:00 2001 From: Myk Date: Mon, 6 Jan 2025 00:55:46 -0800 Subject: [PATCH] Revert "fix mysterious new errors in CI" --- docs/dev/Lua API.rst | 19 ++++++++----------- docs/guides/modding-guide.rst | 4 ---- 2 files changed, 8 insertions(+), 15 deletions(-) diff --git a/docs/dev/Lua API.rst b/docs/dev/Lua API.rst index 6f1fff5de2..64bea03c3a 100644 --- a/docs/dev/Lua API.rst +++ b/docs/dev/Lua API.rst @@ -3155,14 +3155,15 @@ unless otherwise noted. * ``dfhack.filesystem.listdir_recursive(path [, depth = 10[, include_prefix = true]])`` - Lists all files/directories in a directory and its subdirectories. All - directories are listed before their contents. Returns a table with subtables - of the format: ``{path: 'path to file', isdir: true|false}`` + Lists all files/directories in a directory and its subdirectories. All directories + are listed before their contents. Returns a table with subtables of the format:: - Note that ``listdir()`` returns only the base name of each directory entry, - while ``listdir_recursive()`` returns the initial path and all components - following it for each entry. Set ``include_prefix`` to false if you don't - want the ``path`` string prepended to the returned filenames. + {path: 'path to file', isdir: true|false} + + Note that ``listdir()`` returns only the base name of each directory entry, while + ``listdir_recursive()`` returns the initial path and all components following it + for each entry. Set ``include_prefix`` to false if you don't want the ``path`` + string prepended to the returned filenames. Console API ----------- @@ -3702,8 +3703,6 @@ functions. These are invoked just like standard string functions, e.g.:: script-manager ============== -.. highlight:: none - This module contains functions useful for mods that contain DFHack scripts to retrieve source and state paths. The value to pass as ``mod_id`` must be the same as the mod ID in the mod's :file:`info.txt` metadata file. The returned @@ -3742,8 +3741,6 @@ paths will be relative to the top level game directory and will end in a slash utils ===== -.. highlight:: lua - * ``utils.compare(a,b)`` Comparator function; returns *-1* if ab, *0* otherwise. diff --git a/docs/guides/modding-guide.rst b/docs/guides/modding-guide.rst index 5906c75208..e93051d41a 100644 --- a/docs/guides/modding-guide.rst +++ b/docs/guides/modding-guide.rst @@ -238,8 +238,6 @@ immensely, and you can always ask for help in the `right places `. Reading and writing files and other persistent state ---------------------------------------------------- -.. highlight:: none - There are several locations and APIs that a mod might need to read or store data: @@ -256,8 +254,6 @@ for reading and writing JSON data. For example:: -- modify state in the config.data table and persist it when it changes with -- config:write() -.. highlight:: lua - State that should be saved with a world or a specific fort within that world should use `persistent-api` API. You can attach a state change hook for new world loaded where you can load the state, which often includes whether the mod