diff --git a/illuaminate.sexp b/illuaminate.sexp index 38ed350c5..f727a3a8e 100644 --- a/illuaminate.sexp +++ b/illuaminate.sexp @@ -59,3 +59,20 @@ (at /doc/stub (linters -var:unused-global) (lint (allow-toplevel-global true))) + +;; Ensure any fully documented modules stay fully documented. +(at + (/src/main/resources/assets/computercraft/lua/rom/apis/colors.lua + /src/main/resources/assets/computercraft/lua/rom/apis/colours.lua + /src/main/resources/assets/computercraft/lua/rom/apis/disk.lua + /src/main/resources/assets/computercraft/lua/rom/apis/gps.lua + /src/main/resources/assets/computercraft/lua/rom/apis/help.lua + /src/main/resources/assets/computercraft/lua/rom/apis/keys.lua + /src/main/resources/assets/computercraft/lua/rom/apis/paintutils.lua + /src/main/resources/assets/computercraft/lua/rom/apis/parallel.lua + /src/main/resources/assets/computercraft/lua/rom/apis/peripheral.lua + /src/main/resources/assets/computercraft/lua/rom/apis/rednet.lua + /src/main/resources/assets/computercraft/lua/rom/apis/settings.lua + /src/main/resources/assets/computercraft/lua/rom/apis/texutils.lua + /src/main/resources/assets/computercraft/lua/rom/apis/vector.lua) + (linters doc:undocumented doc:undocumented-arg)) diff --git a/src/main/resources/assets/computercraft/lua/rom/apis/settings.lua b/src/main/resources/assets/computercraft/lua/rom/apis/settings.lua index fcfb1d17a..3046f65b1 100644 --- a/src/main/resources/assets/computercraft/lua/rom/apis/settings.lua +++ b/src/main/resources/assets/computercraft/lua/rom/apis/settings.lua @@ -124,7 +124,12 @@ function get(name, default) end end ---- Get details about a specific setting +--- Get details about a specific setting. +-- +-- @tparam string name The name of the setting to get. +-- @treturn { description? = string, default? = value, type? = string, value? = value } +-- Information about this setting. This includes all information from @{settings.define}, +-- as well as this setting's value. function getDetails(name) expect(1, name, "string") local deets = copy(details[name]) or {} diff --git a/src/main/resources/assets/computercraft/lua/rom/apis/window.lua b/src/main/resources/assets/computercraft/lua/rom/apis/window.lua index 57bd70c54..d93533f03 100644 --- a/src/main/resources/assets/computercraft/lua/rom/apis/window.lua +++ b/src/main/resources/assets/computercraft/lua/rom/apis/window.lua @@ -445,7 +445,7 @@ function create(parent, nX, nY, nWidth, nHeight, bStartVisible) -- @treturn string The textual content of this line. -- @treturn string The text colours of this line, suitable for use with @{term.blit}. -- @treturn string The background colours of this line, suitable for use with @{term.blit}. - -- @throws If `y` is a valid line. + -- @throws If `y` is not between 1 and this window's height. function window.getLine(y) if type(y) ~= "number" then expect(1, y, "number") end