finished documentation of modules for now.

marl_factory_grid/modules/doors/actions.py

@@ -10,7 +10,8 @@ class DoorUse(Action):
 
     def __init__(self, **kwargs):
         """
-        Attempts to interact with door (open/close it) and returns an action result if successful.
+        The agent performing this action attempts to interact with door (open/close it), returning an action result if
+        successful.
         """
         super().__init__(d.ACTION_DOOR_USE, d.REWARD_USE_DOOR_VALID, d.REWARD_USE_DOOR_FAIL, **kwargs)
 

marl_factory_grid/modules/doors/entitites.py

@@ -19,7 +19,7 @@ class DoorIndicator(Entity):
 
     def __init__(self, *args, **kwargs):
         """
-        Is added around a door for agents to see.
+        Is added as a padding around doors so agents can see doors earlier.
         """
         super().__init__(*args, **kwargs)
         self.__delattr__('move')

marl_factory_grid/modules/doors/rules.py

@@ -9,7 +9,7 @@ class DoorAutoClose(Rule):
 
     def __init__(self, close_frequency: int = 10):
         """
-        This rule closes doors, that have been opened automatically, when no entity is blocking the position.
+        This rule closes doors that have been opened automatically when no entity is blocking the position.
 
         :type close_frequency: int
         :param close_frequency: How many ticks after opening, should the door close?