MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix parsing of first line as the short_help

develop
myk002 2022-07-10 20:48:24 -07:00
parent fdd406b722
commit 4ed15ffcc4
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
library/lua/helpdb.lua
Unescape Escape View File

@ -92,9 +92,10 @@ end
-- end_marker (string that marks the end of the help text; text will stop -- end_marker (string that marks the end of the help text; text will stop
-- being parsed after this marker is seen) -- being parsed after this marker is seen)
-- no_header (don't try to find the entity name at the top of the help text) -- no_header (don't try to find the entity name at the top of the help text)
-- first_line_is_short_help (read the short help text from the first commented -- first_line_is_short_help (if set, then read the short help text from the
-- line of the script instead of using the first -- first commented line of the script instead of
-- sentence of the long help text) -- using the first sentence of the long help text.
-- value is the comment character.)
local function update_entry(entry, iterator, opts) local function update_entry(entry, iterator, opts)
opts = opts or {} opts = opts or {}
local lines = {} local lines = {}
@ -104,7 +105,7 @@ local function update_entry(entry, iterator, opts)
for line in iterator do for line in iterator do
if not short_help_found and first_line_is_short_help then if not short_help_found and first_line_is_short_help then
line = line:trim() line = line:trim()
local _,_,text = line:find('^%-%-%s*(.*)') or line:find('^#%s*(.*)') local _,_,text = line:find('^'..first_line_is_short_help..'%s*(.*)')
if not text then if not text then
-- if no first-line short help found, fall back to getting the -- if no first-line short help found, fall back to getting the
-- first sentence of the help text. -- first sentence of the help text.
@ -212,7 +213,7 @@ local function make_script_entry(old_entry, entry_name, script_source_path)
update_entry(entry, lines, update_entry(entry, lines,
{begin_marker=(is_rb and SCRIPT_DOC_BEGIN_RUBY or SCRIPT_DOC_BEGIN), {begin_marker=(is_rb and SCRIPT_DOC_BEGIN_RUBY or SCRIPT_DOC_BEGIN),
end_marker=(is_rb and SCRIPT_DOC_BEGIN_RUBY or SCRIPT_DOC_END), end_marker=(is_rb and SCRIPT_DOC_BEGIN_RUBY or SCRIPT_DOC_END),
first_line_is_short_help=true}) first_line_is_short_help=(is_rb and '#' or '%-%-')})
return entry return entry
end end