ware_help.lua
---------------

This script returns a formatted entry for the ingame ware help.
Pass the internal tribe name and ware name to the coroutine to select the
ware type.

.. function:: ware_help_general_string(tribe, ware_description)

   Displays general info texts about the ware

   :arg tribe: The :class:`wl.map.TribeDescription` for a tribe that uses this ware.
   :arg ware_description: the ware_description from C++.
   :returns: General info about the ware


.. function:: ware_help_producers_string(tribe, ware_description)

   Displays the buildings that produce this ware with information about
   wares consumed in their production programs

   :arg tribe: The :class:`wl.map.TribeDescription` for a tribe that uses this ware.
   :arg ware_description: the ware_description from C++.
   :returns: Info about buildings producing this ware and the production cost.


.. function:: ware_help_consumers_string(tribe, ware_description)

   Displays the buildings that consume this ware and about
   workers that use this ware as a tool

   :arg tribe: The :class:`wl.map.TribeDescription` for a tribe that uses this ware.
   :arg ware_description: the ware_description from C++.
   :returns: Info about buildings and workers that use this ware