Correct invalid docstrings; s/Found/Error/

Code Issues Proposed changes

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

This commit is contained in:

Jay Faulkner

2024年03月06日 08:32:48 -08:00

parent 959e8250ce

commit 9de74b630b

1 changed files with 3 additions and 3 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

6
ironic_python_agent/hardware.py

View File

@@ -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.

Correct invalid docstrings; s/Found/Error/

6 ironic_python_agent/hardware.py Unescape Escape View File

6
ironic_python_agent/hardware.py

View File