widelands-dev team mailing list archive

[kaputtnik <somal@xxxxxxxx>]

kaputtnik has proposed merging lp:~widelands-dev/widelands/add_lua_path into lp:widelands.

Commit message:
Add lua_path.cc to the documentation

Requested reviews:
  Widelands Developers (widelands-dev)

For more details, see:
https://code.launchpad.net/~widelands-dev/widelands/add_lua_path/+merge/345202

Since this was documented but not included in the documentation, i've added it.

Not sure about the position...
-- 
Your team Widelands Developers is requested to review the proposed merge of lp:~widelands-dev/widelands/add_lua_path into lp:widelands.

=== modified file 'doc/sphinx/extract_rst.py'
--- doc/sphinx/extract_rst.py	2017-12-11 09:08:08 +0000
+++ doc/sphinx/extract_rst.py	2018-05-07 20:17:48 +0000
@@ -22,6 +22,7 @@
     ('src/scripting/lua_game.cc', 'autogen_wl_game.rst'),
     ('src/scripting/lua_ui.cc', 'autogen_wl_ui.rst'),
     ('src/scripting/lua_globals.cc', 'autogen_globals.rst'),
+    ('src/scripting/lua_path.cc', 'autogen_path.rst'),
     ('src/logic/map_objects/tribes/worker_program.cc', 'autogen_tribes_worker_programs.rst'),
 )
 

=== modified file 'doc/sphinx/source/core.rst'
--- doc/sphinx/source/core.rst	2012-06-20 09:07:10 +0000
+++ doc/sphinx/source/core.rst	2018-05-07 20:17:48 +0000
@@ -8,6 +8,7 @@
    :maxdepth: 3
 
    autogen_globals
+   autogen_path
    autogen_wl
    autogen_wl_bases
    autogen_wl_editor

=== modified file 'src/scripting/lua_path.cc'
--- src/scripting/lua_path.cc	2018-04-07 16:59:00 +0000
+++ src/scripting/lua_path.cc	2018-05-07 20:17:48 +0000
@@ -133,7 +133,7 @@
 .. function:: list_files(filename_template)
 
    Lists the full path for all files that fit the template pattern.
-   Use ? as placeholders for numbers, e.g. 'directory/idle_??.png' will list
+   Use ? as placeholders for numbers, e.g. 'directory/idle\_??.png' will list
    'directory/idle_00.png', 'directory/idle_01.png' etc, and
    'directory/idle.png' will just list 'directory/idle.png'.