Add test for ldoc warnings

1337joe · Nov 20, 2022 · 1d28f7a · 1d28f7a
1 parent 3a9d160
commit 1d28f7a
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -29,13 +29,17 @@ jobs:
       - name: Setup
         run: |
           luarocks install --only-deps du-mocks-scm-0.rockspec
+          luarocks install ldoc
           luarocks install luaunit
           luarocks install luacov
           luarocks install luafilesystem
 
       - name: Verify LuaRocks config
         run: luarocks make
 
+      - name: Verify codex builds cleanly
+        run: ldoc . --fatalwarnings
+
       - name: Test
         run: ./test/runTests.sh -o junit
 

diff --git a/src/dumocks/ControlUnit.lua b/src/dumocks/ControlUnit.lua
@@ -164,7 +164,7 @@ end
 
 --- Set up a timer with a given tag in a given period. This will start to trigger the 'onTimer' event with the
 -- corresponding tag as an argument, to help you identify what is ticking, and when.
--- @tparam string tag The tag of the timer, as a string, which will be used in the 'onTimer' event to identify this
+-- @tparam string tag1 The tag of the timer, as a string, which will be used in the 'onTimer' event to identify this
 -- particular timer.
 -- @tparam second period The period of the timer, in seconds. The time resolution is limited by the framerate here, so
 -- you cannot set arbitrarily fast timers.