finished documentation of modules for now.

marl_factory_grid/modules/clean_up/actions.py

@@ -12,7 +12,7 @@ class Clean(Action):
 
     def __init__(self):
         """
-        Attempts to reduce dirt amount on entity's position.
+        Attempts to reduce dirt amount on entity's position. Fails if no dirt is found at the at agents' position.
         """
         super().__init__(d.CLEAN_UP, d.REWARD_CLEAN_UP_VALID, d.REWARD_CLEAN_UP_FAIL)
 

marl_factory_grid/modules/clean_up/entitites.py

@@ -18,7 +18,8 @@ class DirtPile(Entity):
 
     def __init__(self, *args, amount=2, max_local_amount=5, **kwargs):
         """
-        Represents a pile of dirt at a specific position in the environment.
+        Represents a pile of dirt at a specific position in the environment that agents can interact with. Agents can
+        clean the dirt pile or, depending on activated rules, interact with it in different ways.
 
         :param amount: The amount of dirt in the pile.
         :type amount: float