From bf7b39f214e12057a78eb63d892eae8746da6cac Mon Sep 17 00:00:00 2001 From: uramer Date: Sat, 8 Jul 2023 18:40:33 +0200 Subject: [PATCH 1/2] Fix typos in Lua documentation --- files/data/scripts/omw/activationhandlers.lua | 2 +- files/lua_api/openmw/interfaces.lua | 2 +- files/lua_api/openmw/types.lua | 4 ++-- files/lua_api/openmw/util.lua | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/files/data/scripts/omw/activationhandlers.lua b/files/data/scripts/omw/activationhandlers.lua index 95a9c36dae..7bc7ee04e1 100644 --- a/files/data/scripts/omw/activationhandlers.lua +++ b/files/data/scripts/omw/activationhandlers.lua @@ -71,7 +71,7 @@ return { -- If `handler(object, actor)` returns false, other handlers for -- the same object (including type handlers) will be skipped. -- @function [parent=#Activation] addHandlerForType - -- @param #userdata type A type from the `openmw.types` package. + -- @param #any type A type from the `openmw.types` package. -- @param #function handler The handler. addHandlerForType = function(type, handler) local handlers = handlersPerType[type] diff --git a/files/lua_api/openmw/interfaces.lua b/files/lua_api/openmw/interfaces.lua index 36032acb2f..827b9e57d7 100644 --- a/files/lua_api/openmw/interfaces.lua +++ b/files/lua_api/openmw/interfaces.lua @@ -3,7 +3,7 @@ -- @usage local I = require('openmw.interfaces') --- --- @field [parent=#interfaces] scripts.omw.ai#scripts.omw.activationhandlers Activation +-- @field [parent=#interfaces] scripts.omw.activationhandlers#scripts.omw.activationhandlers Activation --- -- @field [parent=#interfaces] scripts.omw.ai#scripts.omw.ai AI diff --git a/files/lua_api/openmw/types.lua b/files/lua_api/openmw/types.lua index 55f3888c90..72d87edbf8 100644 --- a/files/lua_api/openmw/types.lua +++ b/files/lua_api/openmw/types.lua @@ -944,7 +944,7 @@ -- @field #string icon VFS path to the icon -- @field #number weight -- @field #number value --- @field #list effects The effects (@{#list}) of the ingredient +-- @field #list effects The effects (@{#list}) of the ingredient --- @{#Lockable} functions @@ -1127,7 +1127,7 @@ -- @field #string icon VFS path to the icon -- @field #number weight -- @field #number value --- @field #list effects The effects (@{#list}) of the potion +-- @field #list effects The effects (@{#list}) of the potion diff --git a/files/lua_api/openmw/util.lua b/files/lua_api/openmw/util.lua index 349fe6a511..98d46096f4 100644 --- a/files/lua_api/openmw/util.lua +++ b/files/lua_api/openmw/util.lua @@ -407,14 +407,14 @@ --- -- Creates a new Box with a given center and half sizes. Boxes are immutable and can not be changed after creation. --- @function [parent=#util] Box +-- @function [parent=#util] box -- @param #Vector3 center -- @param #Vector3 halfSize in each dimension (x, y, z) -- @return #Box --- -- Creates a new Box from a given transformation. Boxes are immutable and can not be changed after creation. --- @function [parent=#util] Box +-- @function [parent=#util] box -- @param #Transform transform A transformation which encapsulates the boxes center pointer (translation), half sizes (scale), and rotation. -- @return #Box -- @usage From d4d2112b06188f4e5f695f698e1a334a4a5c3c80 Mon Sep 17 00:00:00 2001 From: uramer Date: Sat, 8 Jul 2023 18:44:15 +0200 Subject: [PATCH 2/2] Fail Teal generation on any error --- CI/teal_ci.sh | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CI/teal_ci.sh b/CI/teal_ci.sh index cc07577406..5ea312e88c 100755 --- a/CI/teal_ci.sh +++ b/CI/teal_ci.sh @@ -1,3 +1,5 @@ +set -e + docs/source/install_luadocumentor_in_docker.sh PATH=$PATH:~/luarocks/bin