widelands-dev team mailing list archive

[SirVer <SirVer@xxxxxx>]

SirVer has proposed merging lp:~widelands-dev/widelands/document_mine into lp:widelands.

Commit message:
Document the mine command. I read through the code to get to this documentation, I hope it is correct.

Requested reviews:
  Widelands Developers (widelands-dev)

For more details, see:
https://code.launchpad.net/~widelands-dev/widelands/document_mine/+merge/313509
-- 
Your team Widelands Developers is requested to review the proposed merge of lp:~widelands-dev/widelands/document_mine into lp:widelands.

=== modified file 'doc/sphinx/source/productionsite_program.rst'
--- doc/sphinx/source/productionsite_program.rst	2016-03-07 10:28:35 +0000
+++ doc/sphinx/source/productionsite_program.rst	2016-12-18 21:04:18 +0000
@@ -186,7 +186,14 @@
 
 mine
 ----
-Takes resources from the ground. This command type is subject to change.
+Takes resources from the ground. It takes as arguments first the resource
+name, after this the radius for searching for the resource around the building
+field. The next values is the percentage of starting resources that can be dug
+out before this mine is exhausted. The next value is the percentage that this
+building still produces something even if it is exhausted. And the last value
+is the percentage chance that a worker is gaining experience on failure - this
+is to guarantee that you can eventually extend a mine, even though it was
+exhausted for a while already.
 
 check_soldier
 -------------