From 9de74b630bcd06f99bc76b080c814d888f941bcc Mon Sep 17 00:00:00 2001 From: Jay Faulkner Date: Wed, 6 Mar 2024 08:32:48 -0800 Subject: [PATCH] Correct invalid docstrings; s/Found/Error/ It's clear the docstrings intended to indicate ProtectedDeviceError, but instead indicate ProtectedDeviceFound. This clears up the documentation to assist deployers trying to implement hardware managers. Change-Id: Iea534f58aeec60b3862099c1d89be829654a54c1 --- ironic_python_agent/hardware.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ironic_python_agent/hardware.py b/ironic_python_agent/hardware.py index d028b2cdd..b2472272a 100644 --- a/ironic_python_agent/hardware.py +++ b/ironic_python_agent/hardware.py @@ -1030,7 +1030,7 @@ class HardwareManager(object, metaclass=abc.ABCMeta): :param node: Ironic node object :param ports: list of Ironic port objects - :raises: ProtectedDeviceFound if a device has been identified which + :raises: ProtectedDeviceError if a device has been identified which may require manual intervention due to the contents and operational risk which exists as it could also be a sign of an environmental misconfiguration. @@ -1933,7 +1933,7 @@ class GenericHardwareManager(HardwareManager): :param ports: list of Ironic port objects :raises BlockDeviceEraseError: when there's an error erasing the block device - :raises: ProtectedDeviceFound if a device has been identified which + :raises: ProtectedDeviceError if a device has been identified which may require manual intervention due to the contents and operational risk which exists as it could also be a sign of an environmental misconfiguration. @@ -1964,7 +1964,7 @@ class GenericHardwareManager(HardwareManager): :param ports: list of Ironic port objects :raises BlockDeviceEraseError: when there's an error erasing the block device - :raises: ProtectedDeviceFound if a device has been identified which + :raises: ProtectedDeviceError if a device has been identified which may require manual intervention due to the contents and operational risk which exists as it could also be a sign of an environmental misconfiguration.