Skip to content

Commit

Permalink
auth docs: reword LUA return paragraph
Browse files Browse the repository at this point in the history
Avoids misrender and warning from sphinx.
  • Loading branch information
zeha committed Aug 27, 2024
1 parent abe0199 commit d69194e
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/lua-records/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,9 +177,10 @@ outside of Europe will hit 198.51.100.1 as long as it is available, and the

Advanced topics
---------------
By default, LUA records are executed with ``return `` prefixed to them. This saves
a lot of typing for common cases. To run actual Lua scripts, start a record with a ``;``
which indicates no ``return `` should be prepended.

By default, LUA records are executed as if they were the argument to Lua's ``return`` statement.
This saves a lot of typing for common cases.
To run actual Lua scripts, start a record with a semicolon (``;``). You need to add your own ``return`` statement.

To keep records more concise and readable, configuration can be stored in
separate records. The full example from above can also be written as::
Expand Down

0 comments on commit d69194e

Please sign in to comment.