Merge lp:~widelands-dev/widelands/document_mine into lp:widelands

[SirVer]

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

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 1779. State: passed. Details: https://travis-ci.org/widelands/widelands/builds/185001578.
Appveyor build 1617. State: success. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_document_mine-1617.

[GunChleoc (gunchleoc)]

+1 to more documentation :)

How about adding a small code example to illustrate, and/or turning this into a list? Kaputtnik and I fiddled with the format for this with the (still incomplete) Tribes units and animations:

https://wl.widelands.org/docs/wl/autogen_toc_lua_tribes_buildings/

https://wl.widelands.org/docs/wl/animations/

[SirVer (sirver)]

I had no intention on working on this further - I just felt that my digging should not go unused. Let's not let the good be the enemy of better.

> Am 19.12.2016 um 11:19 schrieb GunChleoc <email address hidden>:
>
> +1 to more documentation :)
>
> How about adding a small code example to illustrate, and/or turning this into a list? Kaputtnik and I fiddled with the format for this with the (still incomplete) Tribes units and animations:
>
> https://wl.widelands.org/docs/wl/autogen_toc_lua_tribes_buildings/
>
> https://wl.widelands.org/docs/wl/animations/
> --
> 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.
>
> _______________________________________________
> Mailing list: https://launchpad.net/~widelands-dev
> Post to : <email address hidden>
> Unsubscribe : https://launchpad.net/~widelands-dev
> More help : https://help.launchpad.net/ListHelp

[GunChleoc (gunchleoc)]

OK, let's get the information in then and make it more readable later. I am planning to do more work on the documentation once I have cleared my backlog of branches a bit.

@bunnybot merge

=== 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
 -------------