widelands-dev team mailing list archive

[kaputtnik <somal@xxxxxxxx>]

Forgot to save the inline comment...

Diff comments:

> 
> === modified file 'src/logic/map_objects/tribes/worker_program.cc'
> --- src/logic/map_objects/tribes/worker_program.cc	2017-01-25 18:55:59 +0000
> +++ src/logic/map_objects/tribes/worker_program.cc	2017-08-27 19:05:15 +0000
> @@ -30,6 +30,31 @@
>  #include "sound/sound_handler.h"
>  
>  namespace Widelands {
> +/* RST
> +.. _tribes_worker_programs:
> +
> +Worker Programs
> +===============
> +
> +Worker programs are defined in the ``programs`` subtable specified in calls to
> +:ref:`tribes:new_worker_type <lua_tribes_workers_common>`.
> +Each worker program is a Lua table in itself and defined as a series of command strings.
> +Commands can also have parameters, which are separated from each other by a blank space.
> +The table looks like this::
> +
> +   programs = {
> +      program1 = {

Better use 'programname1' or add a comment like: '-- The name of the program, e.g.: harvest, mine, breed, ...' So a reader can better combine the code examples below and this abstraction.

> +         "command1 parameter1 parameter2",
> +         "command2 parameter1",
> +         "return"
> +      },
> +      program2 = {
> +         "command3",
> +         "command4 parameter1 parameter2 parameter3",
> +         "return"
> +      }
> +   },
> +*/
>  
>  const WorkerProgram::ParseMap WorkerProgram::parsemap_[] = {
>     {"mine", &WorkerProgram::parse_mine},


-- 
https://code.launchpad.net/~widelands-dev/widelands/document_worker_program/+merge/329696
Your team Widelands Developers is requested to review the proposed merge of lp:~widelands-dev/widelands/document_worker_program into lp:widelands.