From 1f9384542e695ae1a6fcbf9b7ee197a7e689a12a Mon Sep 17 00:00:00 2001 From: Albert Krewinkel Date: Thu, 15 Aug 2019 22:53:02 +0200 Subject: Lua: improve function documentations --- src/Text/Pandoc/Lua/Filter.hs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'src/Text') diff --git a/src/Text/Pandoc/Lua/Filter.hs b/src/Text/Pandoc/Lua/Filter.hs index 9efc2b9ae..9416bf41f 100644 --- a/src/Text/Pandoc/Lua/Filter.hs +++ b/src/Text/Pandoc/Lua/Filter.hs @@ -93,7 +93,10 @@ pushFilterFunction :: LuaFilterFunction -> Lua () pushFilterFunction (LuaFilterFunction fnRef) = Lua.getref Lua.registryindex fnRef - +-- | Fetch either a list of elements from the stack. If there is a single +-- element instead of a list, fetch that element as a singleton list. If the top +-- of the stack is nil, return the default element that was passed to this +-- function. If none of these apply, raise an error. elementOrList :: Peekable a => a -> Lua [a] elementOrList x = do let topOfStack = Lua.stackTop -- cgit v1.2.3