Fix docstrings

sea-bass · Aug 30, 2024 · 236909b · 236909b
1 parent e3c08b3
commit 236909b
Showing 1 changed file with 8 additions and 8 deletions.
diff --git a/pyrobosim/pyrobosim/core/world.py b/pyrobosim/pyrobosim/core/world.py
@@ -468,8 +468,8 @@ def open_location(self, location):
         """
         Opens a storage location or hallway between two rooms..
 
-        :param location: Location or Hallway object to open.
-        :type location: :class:`pyrobosim.core.locations.Location` or :class:`pyrobosim.core.hallway.Hallway`
+        :param location: Location or Hallway object to open, or its name.
+        :type location: :class:`pyrobosim.core.locations.Location`, :class:`pyrobosim.core.hallway.Hallway`, or str
         :return: An object describing the execution result.
         :rtype: :class:`pyrobosim.planning.actions.ExecutionResult`
         """
@@ -520,8 +520,8 @@ def close_location(self, location, ignore_robots=[]):
         """
         Close a storage location or hallway.
 
-        :param location: Location or Hallway object to close.
-        :type location: :class:`pyrobosim.core.locations.Location` or :class:`pyrobosim.core.hallway.Hallway`
+        :param location: Location or Hallway object to close, or its name.
+        :type location: :class:`pyrobosim.core.locations.Location`, :class:`pyrobosim.core.hallway.Hallway`, or str
         :param ignore_robots: List of robots to ignore, for example the robot closing the hallway.
         :type ignore_robots: list[:class:`pyrobosim.core.robot.Robot`]
         :return: An object describing the execution result.
@@ -584,8 +584,8 @@ def lock_location(self, location):
         """
         Locks a storage location or hallway.
 
-        :param location: Location object to lock.
-        :type location: :class:`pyrobosim.core.locations.Location` or :class:`pyrobosim.core.hallway.Hallway`
+        :param location: Location or Hallway object to lock, or its name.
+        :type location: :class:`pyrobosim.core.locations.Location`, :class:`pyrobosim.core.hallway.Hallway`, or str
         :return: An object describing the execution result.
         :rtype: :class:`pyrobosim.planning.actions.ExecutionResult`
         """
@@ -622,8 +622,8 @@ def unlock_location(self, location):
         """
         Unlocks a storage location or hallway.
 
-        :param location: Location object to unlock.
-        :type location: :class:`pyrobosim.core.locations.Location` or :class:`pyrobosim.core.hallway.Hallway`
+        :param location: Location or Hallway object to unlock, or its name.
+        :type location: :class:`pyrobosim.core.locations.Location`, :class:`pyrobosim.core.hallway.Hallway`, or str
         :return: An object describing the execution result.
         :rtype: :class:`pyrobosim.planning.actions.ExecutionResult`
         """