Skip to content

Add more detail about --@ lines in the Lua API doc. #5668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ab9rf merged 1 commit into from
Dec 4, 2025
+9 −0
Merged

Add more detail about --@ lines in the Lua API doc. #5668

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/dev/Lua API.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7468,6 +7468,15 @@ Importing scripts

--@ module = true

In order to be recognized, this line **must** begin with ``--@`` with no
whitespace characters before it::

--@ module = true OK
--@module = true OK
-- @module = true NOT OK (no --@ found due to space after --)
--@module = true NOT OK (leading space, --@ is not at the beginning of the line)
---@module = true NOT OK (leading dash, --@ is not at the beginning of the line)

2. Include a check for ``dfhack_flags.module``, and avoid running any code
that has side-effects if this flag is true. For instance::

Expand Down